Skip to content

Project overview page: Have README link in-page to README section

Everyone can contribute. Help move this issue forward while earning points, leveling up and collecting rewards.

Context

In #24746 (closed), users cited having to scroll to see the README file at the bottom of the Project Overview page. When the issue was started, the Project Overview page did not have the right-hand sidebar with the README link.

To read the contents of the README.md file, I always have to scroll down a sometimes really long file list shown on the Project overview page.

#24746 (comment 410727587)

making our Helpdesk techs scroll through a file list to get to the README (which we're using as the documentation index page) is not a great UX either

#24746 (comment 616439165)

Design Proposal

Currently, the README link redirects to the README file page. The design proposal is to redirect the README link to the README section at the bottom of the page, to provide users a way to quickly navigate to the section without scrolling.

readme.png

Edited by 🤖 GitLab Bot 🤖