docs: fix usage of terminal directive
Metadata
Current evaluation
Terminal directives were reworked and sphinx-terminal 1.1.0 adopted in merged PR #2870 (commit a5cfbafb), resolving the documentation issue after an initial Starter Pack update.
Resolution: closed resolved
Reason: PR #2870 was merged as commit a5cfbafb, adopting sphinx-terminal 1.1.0 and completing the requested terminal-directive cleanup. PR #2810 provided an interim correction across 11 documentation files.
Evaluated by: mr-cal-bot
No scores available.
Issue body
### Check existing issues
- [x] I've verified that this request isn't described by any existing issues.
### Request
The `terminal` directive extension was refactored, making the input shown by default, even if empty. To hide the input, the directive must declare `:output-only:`.
Review all instances of the terminal directive:
- Assess whether it should be a [code block, terminal text, or a blockquote](https://canonical-starflow.readthedocs-hosted.com/how-to/starcraft-style-guide/#code-blocks-and-quotations).
- Provide input where it's missing.
- Set `:output-only:` when no input was intended.
### Document location
_No response_
Evaluation history
| Date | Model | Scores | Action | Summary |
|---|---|---|---|---|
| stealth/space-bunny-alpha | — | closed resolved | Terminal directives were reworked and sphinx-terminal 1.1.0 adopted in merged PR #2870 (commit a5cfbafb), resolving the documentation issue after an initial Starter Pack update. | |
| stealth/space-bunny-alpha | — | closed resolved | Updated the docs build to Canonical Starter Pack 1.5 in #2594 (commit 6264ff78), resolving the terminal-directive regression. Follow-up documentation cleanup landed in #2810 and #2870. | |
| qwen/qwen3.6-35b-a3b | — | — | 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. | |
| qwen/qwen3.8-27b |
Impact:
25
Quick Win:
16
Staleness:
30
Complexity:
35
Confidence:
80
Support Request:
0
|
keep open | Docs task to review all terminal directive usages in charmcraft docs: add missing input, set :output-only:, or convert to code blocks. Partially addressed by merged PR #2810 (temporary fix); last comment (2026-07-23) says more attention is needed. | |
| qwen3.6-35b-a3b-mtp-q6 |
Staleness:
10
Complexity:
15
Confidence:
90
Support Request:
0
|
keep open | Documentation task to update terminal directive usage following a Sphinx extension refactor. Currently under active maintainer discussion after an initial resolution was reconsidered; requires further review and implementation. | |
| qwen/qwen3.6-35b-a3b | — | — | Resolved and merged in pull request #2594. Documentation updates corrected terminal directive usage to align with the refactored canonical-sphinx-extensions, adding missing inputs and applying the output-only flag where needed. | |
| qwen3.6-35b-a3b-mtp-q6 |
Staleness:
45
Complexity:
20
Confidence:
85
Support Request:
5
|
keep open | Documentation issue requesting a review and update of the terminal directive usage to match recent Sphinx extension refactoring. Currently triaged but inactive for ~139 days pending upstream dependency updates. | |
| qwen3.6-35b-a3b-mtp-q6 |
Staleness:
70
Complexity:
10
Confidence:
85
Support Request:
0
|
keep open | Documentation issue requesting review and updates to terminal directive usage following an upstream extension refactor. Labeled triaged but inactive for 136 days, pending future Starter Pack integration. |
Update history
| Date | Change |
|---|---|
| closed | |
| updated | |
| closed |
Related work
-
Likely Fixed By:
canonical/charmcraft#2870
(confidence 100%)
Merged final terminal-directive rework as commit a5cfbafb.
-
Related To:
canonical/charmcraft#2810
(confidence 98%)
Merged interim terminal-directive corrections across 11 files.
-
Related To:
canonical/charmcraft#2594
(confidence 90%)
Merged Starter Pack 1.5 update as commit 6264ff78 and initially reported as resolving the regression.
Related issues
| Issue | Project | State | Summary | Similarity |
|---|---|---|---|---|
| #2870 docs: rework terminal directives | charmcraft | merged | Merged as a5cfbafb: docs-only PR reworking Sphinx terminal directives (removing non-meaningful directives, cleaning surrounding text, dropping deploy steps from 'Pack a hooks-based' charm) and bumping sphinx-terminal to 1.1.0; resolves #2563. | |
| #2810 docs: fix terminal directives | charmcraft | merged | Docs-only PR by maintainer jahn-junior merged to fix broken Sphinx terminal directive rendering in 11 documentation files (+225/-266). Author called it a stopgap pending CHARMCRAFT-684; all CI checks passed. | |
| #1079 docs: fix terminal directive | craft-application | merged | Merged #1079 in commit 28df6ac7, fixing the terminal directive so its example renders as multiline input. | |
| #6112 build(deps): update dependency sphinx-terminal to v1 (main) | snapcraft | closed | Closed unmerged; Renovate ignored the 1.x line. A later documentation-dependency update adopted sphinx-terminal~=1.0. |