docs: rework terminal directives
Metadata
Current evaluation
Merged documentation update that reworks terminal directives by removing unhelpful examples, cleaning up text, and removing deployment instructions from a charm guide. Bumped sphinx-terminal to 1.1.0 and resolved issue #2563.
Suggested action: —
No scores available.
Issue body
- Remove terminal directives that don't display meaningful output or show an example command interaction
- Clean up text around some terminal directives (not really in the scope but I wanted to fix some issues while I was here)
- Remove deployment instructions from 'Pack a hooks-based' charm (these were terminal directives so it counts)
- Bump `sphinx-terminal` to 1.1.0
Resolves https://github.com/canonical/charmcraft/issues/2563
---
- [X] I've followed the [contribution guidelines](https://github.com/canonical/charmcraft/blob/main/CONTRIBUTING.md).
- [X] I've signed the [CLA](http://www.ubuntu.com/legal/contributors/).
~~I've successfully run `make lint && make test`.~~
~~I've added or updated any relevant documentation.~~
~~In documents I changed, I [added a meta description](https://canonical-starflow.readthedocs-hosted.com/how-to/add-a-page-meta-description/) if one was missing.~~ Planning to refactor most of these pages soon, so this would be wasted effort.
~~I've updated the relevant release notes.~~
Evaluation history
| Date | Model | Scores | Action | Summary |
|---|---|---|---|---|
| qwen/qwen3.6-35b-a3b | — | — | Merged documentation update that reworks terminal directives by removing unhelpful examples, cleaning up text, and removing deployment instructions from a charm guide. Bumped sphinx-terminal to 1.1.0 and resolved issue #2563. | |
| qwen3.6-35b-a3b-mtp-q6 |
Impact:
30
Quick Win:
25.5
Staleness:
10
Complexity:
15
Confidence:
75
|
needs review | Reworks terminal directives in docs: removes unhelpful directives, cleans up text, removes deployment instructions from hooks-based charm docs, bumps sphinx-terminal to 1.1.0. Fresh PR, pending review, CI passing. |
Update history
| Date | Change |
|---|---|
| updated | |
| updated | |
| updated | |
| updated | |
| created |
Related issues
| Issue | Project | State | Summary | Similarity |
|---|---|---|---|---|
| #2810 docs: fix terminal directives | charmcraft | merged | Merged documentation updates fixing terminal directive rendering. Approved by one reviewer and passing all CI checks, the changes serve as a temporary fix until CHARMCRAFT-684 is implemented, modifying 11 files. | |
| #1079 docs: fix terminal directive | craft-application | merged | Merged a one-line documentation fix correcting the terminal directive rendering for multiline input. Approved by one reviewer with all CI checks passing. | |
| #2563 docs: fix usage of terminal directive | charmcraft | closed | Terminal directive documentation was updated via PR #2594. A follow-up review indicated the changes require further adjustments, leaving the resolution incomplete pending additional fixes. |