rules_pkg icon indicating copy to clipboard operation
rules_pkg copied to clipboard

Include a link to the hosted documentation in the repository details

Open christianscott opened this issue 1 year ago • 3 comments

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

christianscott avatar Aug 07 '24 02:08 christianscott

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

aiuto avatar Aug 13 '24 04:08 aiuto

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

christianscott avatar Aug 13 '24 04:08 christianscott

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.

aiuto avatar Aug 13 '24 20:08 aiuto