Skip to content

Feature: Add README to project home view

username-removed-45462 requested to merge hacker.root/gitlab-ce:feature/README_display into master

Implements feature request "Add README to project home view" http://feedback.gitlab.com/forums/176466-general/suggestions/6256518-add-readme-to-project-home-view

I noticed that there is already a README link next to the project description, so I moved the README button in the sidebar and converted it to a js-toggle-button to show/hide the README. Note that while the old link was shown conditionally based on ownership, this button is always shown.

Screenshots

New README button

new_README_button

README open

new_README_button_open

Mobile

new_README_button_mobile   new_README_button_open_mobile

Discussion

Aesthetically, I think it would be more pleasing if the commit/branch/tag stats were placed at the top of the activity feed (follow the horizontal line), especially in the mobile layout. This would also make sense since the stats are essentially a summary of the activity feed. This would require some style to place it between the two columns but still draw below them in the desktop layout.

Currently the README always defaults to closed each load, but I think the right solution would be to default to open but track the state so that it remembers if you close it. Either that or somehow let people link to it in the open state.

Merge request reports