Skip to content

Add Early Reference to GitHub Repo in Docs #3017

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
empt-ak opened this issue Jun 4, 2025 · 0 comments
Open

Add Early Reference to GitHub Repo in Docs #3017

empt-ak opened this issue Jun 4, 2025 · 0 comments

Comments

@empt-ak
Copy link

empt-ak commented Jun 4, 2025

Is your feature request related to a problem? Please describe.

I usually go through the documentation when I'm trying to solve a problem. If I can't find the answer there, GitHub is my second stop to look through issues. Currently, the first link to the GitHub repository appears to be in section 10... way past the midpoint of the documentation.

If you look at it from the perspective of the GitHub repository, the full documentation is essentially just the second headline in the README. So it would be great to have a similar early point of reference to the GitHub repo in the documentation as well

Describe the solution you'd like

It would be helpful to have a link to the GitHub project somewhere in the "hero" section or the Introduction. Or perhaps as part of the navigation menu on the left?

Describe alternatives you've considered

  • I can open the "Sponsors" section and click on the project name. (not direct)
  • I can open the demo link, then navigate to the repo owner, and finally to the project. (not direct)
  • remeber it's in section 10, then go to GitHub

Additional context

I hope it's not just hidden and I'm missing it, but the first mention of GitHub seems to be in section 3.8.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant