← Back to issue list

docs: fix usage of terminal directive

View original Github issue

Metadata

Project
charmcraft
Number
#2563
Type
issue
State
open
Author
medubelko
Labels
Status: Triaged Type: Documentation
Created
2026-02-04 22:34:23+00:00
Updated
2026-02-18 16:10:26+00:00
Closed

Current evaluation

Documentation update needed to correct terminal directive usage by adding inputs or marking outputs as read-only, currently triaged and awaiting implementation pending upstream Sphinx extension updates.

Suggested action: keep open

Reason: The issue is already triaged and clearly scoped as a documentation fix. It remains valid but is currently waiting on a dependency release (as noted in the maintainer comments), so it should be kept open for future implementation rather than closed or marked for immediate review.

Staleness: 35 Complexity: 20 Confidence: 90 Support Request: 0

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
2026-06-15 12:39:46.551432+00:00 qwen3.6-35b-a3b-mtp-q6
Staleness: 35
Complexity: 20
Confidence: 90
Support Request: 0
keep open Documentation update needed to correct terminal directive usage by adding inputs or marking outputs as read-only, currently triaged and awaiting implementation pending upstream Sphinx extension updates.
2026-06-15 12:37:13.520952+00:00 pending