Skip to content
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

Include a link to the hosted documentation in the repository details #881

Open
christianscott opened this issue Aug 7, 2024 · 3 comments
Labels
documentation P3 An issue that we are not working on but will review quarterly

Comments

@christianscott
Copy link

It's a little bit tricky to find the docs currently. I didn't realise there were any until I found them via google search. You can add a link to the repo details by clicking the gear (⚙️) icon next to "about" on the LHS of the repo homepage

@aiuto aiuto added P3 An issue that we are not working on but will review quarterly documentation labels Aug 13, 2024
@aiuto
Copy link
Collaborator

aiuto commented Aug 13, 2024

I'm not sure what you mean. The links to the docs is in the home page README.

@christianscott
Copy link
Author

yep I can see that but it's easy to miss. this would be a quick way to make it easier for newbies to find the docs

example here in the bazel repo: https://github.com/bazelbuild/bazel

Screenshot 2024-08-13 at 2 46 35 PM

@aiuto
Copy link
Collaborator

aiuto commented Aug 13, 2024

Oh. That. I never would have noticed it. I ignore most boiler-plate. The about box is one I rarely look in. I can see about getting one of the admins go do something.

It still sort of feels funny. A link like that should be to the project rather than a specific part. The bazel.build link is to the overall project - not really the docs. You have to hunt the bazel project site to find the reference pages.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation P3 An issue that we are not working on but will review quarterly
Projects
None yet
Development

No branches or pull requests

2 participants