docs: fix usage of terminal directive
Metadata
Current evaluation
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.
Suggested action: —
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 |
|---|---|---|---|---|
| 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.25
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. | |
| qwen3.6-35b-a3b-mtp-q6 |
Staleness:
60
Complexity:
20
Confidence:
85
Support Request:
5
|
keep open | Update documentation to match the refactored terminal directive by adding missing inputs and applying :output-only: where appropriate. Triaged and awaiting implementation alongside the next Starter Pack release. |
Update history
| Date | Change |
|---|---|
| closed | |
| updated | |
| closed |
Related issues
| Issue | Project | State | Summary | Similarity |
|---|---|---|---|---|
| #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. | |
| #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. | |
| #2870 docs: rework terminal directives | charmcraft | merged | 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. |