canonical / canonical/craft-cli
Remove sphinx directives from overview texts
Open
Status: Triaged
Type: Enhancement
- Dominant language
- Python
- Stars
- 16
- Forks
- 27
- Avg merge
- 1d 22h
- Merged PRs (30d)
- 10
Description
### What needs to get done
Like in #306 , remove sphinx directives from overview texts
### Why it needs to get done
Use cases like https://github.com/canonical/charmcraft/pull/2347
Contributor guide
Research direction
Start by reading issue #306 and locating the overview texts referred to here. Check which Sphinx directives remain in those texts, remove them, and verify that the overview content still renders as intended; no specific files or tests are named in the issue.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100