bazel-contrib / bazel-contrib/rules_jsonnet

Broken documentation links

Open
#265 1 comment 0 reactions 0 assignees View on GitHub
Dominant language
Starlark
Stars
72
Forks
87
PR merge metrics
No merged PRs in 30d

Description

Hello and thank you for your work on rules_jsonnet!

I've noticed that some of the documentation links are broken; it looks like you might be midway through reorganizing, but I wanted to bring attention to it since I'm having trouble finding the right docs.

- On the GitHub repository homepage, the About section links to https://bazelbuild.github.io/rules_jsonnet/, which leads to a 404 on GitHub pages.
- In the README, the Rule usage section links to https://github.com/bazel-contrib/rules_jsonnet/blob/master/docs/jsonnet.md, which no longer exists.
- In `docs/index.html` and in `docs/jsonnet/jsonnet.html`, there is a link to the Bazel central registry at https://registry.bazel.build/docs/rules_jsonnet, but this page says "No API Documentation Available."

Contributor guide

Open the contributing guide

Research direction

Start by checking the repository About link, the README Rule usage link, docs/index.html, and docs/jsonnet/jsonnet.html against the current documentation layout. Verify which documentation and Bazel Central Registry destinations exist, then update or remove the broken references so every listed link reaches the intended content or a valid page.

Written by the indexing model from the issue text.

Assessment

Domain
documentation
Issue type
Documentation
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
42/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.