canonical / canonical/charmlibs
Improve interface readmes
Open
docs
interface-metadata
roadmap
team-charmlibs-maintainers
- Dominant language
- Python
- Stars
- 5
- Forks
- 28
- Avg merge
- 1d 5h
- Merged PRs (30d)
- 24
Description
There are some known documentation issues with the interface `README.md` files that have been migrated to this repo, captured in: https://github.com/canonical/charm-relation-interfaces/issues/127
It would be good to address these as we continue to iron out the interface documentation and discovery process.
Contributor guide
Research direction
Start by reviewing the interface README.md files in this repository and the documented issues in canonical/charm-relation-interfaces#127. Identify which README files and documentation problems are in scope, then update them and verify that the known issues from that reference have been addressed.
Written by the indexing model from the issue text.
Assessment
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Quiet
- Clarity
- Needs clarification
- Newbie friendliness
- 35/100