[docs] Create a build gate that fails the build if there is no matching section matching an option
Nobody has claimed this yet.
- Dominant language
- TypeScript
- Stars
- 816
- Forks
- 88
- PR merge metrics
- No merged PRs in 30d
Description
Currently we use a tool to auto generate documentation from config type. This produces not-so-human friendly docs. We should switch to a model where we simply fail the build if an equivalent section doesn't exist to document an option. This way, we can make sure we're not missing documentation of configuration options while allowing us to express a documentation that is more human friendly.
Contributor guide
No contributing guide indexed for this repository
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start by locating the tool that auto-generates documentation from config types and the build entry point that invokes it. Define the matching-section check there, with completion shown by a build failure for an undocumented configuration option while allowing human-friendly documentation sections.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- typescript
- Domain
- build-system, documentation
- Issue type
- Feature
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 35/100