[go: up one dir, main page]

Skip to content

Project overview page: Add on-hover link to README section

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

Context

In the current Project Overview page, the file list in the repository is displayed before the README file. In #24746 (closed), many users cited concerns about wanting to display the README file first.

Many of the concerns are addressed at users who are unfamiliar with GitLab or version control.

User concerns

Concern Quote
Users who are new to GitLab/source code are intimidated by the file list

Unfortunately users seeing file list instead of README.MD gets scared and frustrated.

#24746 (comment 215507746)

We're (partly) using gitlab for project management and it's nice to have a readme in a project which is otherwise just used for Issues, but having all the repository stuff appear above it is intimidating for non-developers.

#24746 (comment 616649565)

Users have to scroll to see the Readme

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. Moving the README.md contents above the file list will solve a lot of scrolling for the readers.

#24746 (comment 410727587)

We are moving off of Confluence due to the horrible editor, but 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)

Users have documentation repositories and want the Readme shown first

Premium customer #24746 (comment 1776174392)

Design Proposal

Along with #519827 #519996, another quick way to address the scrolling would be to allow users to directly link to the README section within the Project Overview page, similar to how GitLab allows linking to in-page sections in Issues.

Current: Issues page section linking Idea: Project Overview page section linking
issues.png readme-link.jpg
Edited by 🤖 GitLab Bot 🤖