Migrate to Starlark API Docs for BCR
- Dominant language
- Starlark
- Stars
- 37
- Forks
- 23
- PR merge metrics
- No merged PRs in 30d
Description
Recently, there has been a new development in the Bazel Central Registry that allows documentation to be hosted directly on BCR: https://blog.aspect.build/stardocs-on-bcr
The steps to include the docs as part of BCR are documented on the blog. Or an example from `bazel_lib` itself:
https://github.com/bazel-contrib/bazel-lib/blob/0a2f475200309e581f4e0d8aa6989eda7caed4e6/.bcr/source.template.json#L4
https://github.com/bazel-contrib/bazel-lib/blob/0a2f475200309e581f4e0d8aa6989eda7caed4e6/.github/workflows/release_prep.sh#L46-L52
This is nice because it allows package documentation to be centralized and versioned.
Contributor guide
Research direction
Read the linked Stardocs-on-BCR guidance and compare the bazel-lib examples in .bcr/source.template.json and .github/workflows/release_prep.sh. Identify the corresponding configuration and release changes needed in rules_pkl; the work is done when its versioned Starlark API documentation is hosted through BCR.
Written by the indexing model from the issue text.
Assessment
- Domain
- build-system, documentation
- Issue type
- Feature
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 48/100