Document toggle and setting annotations for dependencies
Open
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 6
- Forks
- 16
- PR merge metrics
- No merged PRs in 30d
Description
When looking at toggles and setting documentation for a service, it would be great to see toggles and setting documentation for dependencies.
Notes:
- Should the docs for dependencies come in automatically as part of the sphinx docs? Or, should each service have separate links to the docs of each of its dependencies?
- Should toggles doc be handled differently from settings docs?
Contributor guide
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 reviewing the existing Sphinx documentation for service toggles and settings, then trace how dependencies are represented in that documentation. Decide whether dependency docs should be included automatically or linked per service, and whether toggles and settings need different treatment. Done means the chosen approach documents dependency toggles and settings consistently.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 25/100