bazel-contrib / bazel-contrib/rules_go
Investigate migrating documentation to Stardoc
- Dominant language
- Go
- Stars
- 1.5k
- Forks
- 760
- Avg merge
- 1d 11h
- Merged PRs (30d)
- 12
Description
[Stardoc](https://github.com/bazelbuild/stardoc) is a documentation generator for Bazel rules, providers, and other definitions.
Currently, rules_go documentation is maintained separately from the rule implementation themselves, so it's easy for it to drift.
We should investigate whether Stardoc is a viable replacement for the current documentation. If it is, we should migrate the current documentation to generated Stardoc.
Analogous Gazelle issue bazelbuild/bazel-gazelle#763
Contributor guide
Research direction
Read the Stardoc project and compare its capabilities with the current rules_go documentation and rule implementation. Use the analogous Gazelle issue as context. Done means determining whether Stardoc is viable and, if so, migrating the current documentation to generated Stardoc.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- go
- Domain
- build-system, documentation
- Issue type
- Documentation
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 30/100