canonical / canonical/charmlibs
Auto-generate parts of the interface docs from the schemas
- Dominant language
- Python
- Stars
- 5
- Forks
- 28
- Avg merge
- 1d 5h
- Merged PRs (30d)
- 24
Description
It would be nice if interface library authors didn't need to repeat themselves between the schema and the `README.md` (see for example #353). It would be best if the schema was the source of truth. It should be straightforward to auto-generate the 'Relation Data' section of interface readme pages from the schema when rendering the docs.
Contributor guide
Research direction
Start with the interface README.md pages and their schema definitions, focusing on how the “Relation Data” section is currently written and how the documentation renderer processes those pages. The work is done when that section is generated from the schema as the source of truth, without interface library authors repeating the same data in the README.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- documentation
- Issue type
- Feature
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 45/100