← Back to issue list

docs: fix terminal directives

View original Github issue

Metadata

Project
charmcraft
Number
#2810
Type
pull request
State
merged
Author
jahn-junior
Labels
—
Created
Updated
Closed

Current evaluation

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.

Suggested action: —

No scores available.

Issue body

Note that I did _not_ assess the quality or necessity of any of these terminal directives. This PR is only a stopgap to get everything rendering correctly until I complete [CHARMCRAFT-684](https://warthogs.atlassian.net/browse/CHARMCRAFT-684) next pulse. --- - [ ] I've followed the [contribution guidelines](https://github.com/canonical/charmcraft/blob/main/CONTRIBUTING.md). - [ ] 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. - [ ] I've updated the relevant release notes. [CHARMCRAFT-684]: https://warthogs.atlassian.net/browse/CHARMCRAFT-684?atlOrigin=eyJpIjoiNWRkNTljNzYxNjVmNDY3MDlhMDU5Y2ZhYzA5YTRkZjUiLCJwIjoiZ2l0aHViLWNvbS1KU1cifQ

Evaluation history

Date Model Scores Action Summary
qwen/qwen3.6-35b-a3b — — 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.
qwen3.6-35b-a3b-mtp-q6
Staleness: 5
Complexity: 15
Confidence: 90
needs review Updates documentation to fix terminal directive rendering across 11 files. Approved by one reviewer with one unresolved comment, all CI checks passing.
qwen3.6-35b-a3b-mtp-q6
Staleness: 5
Complexity: 15
Confidence: 90
needs review Documentation update fixing terminal directive rendering issues. Author notes this is a temporary stopgap until CHARMCRAFT-684 is completed. Currently awaiting maintainer review with all CI checks passing.

Update history

Date Change
updated
updated
updated
created

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.
85%
#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.
78%
#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.
78%
#188 docs: document craftctl and step environment craft-parts merged Merged following approval and passing CI checks. Documentation updated to detail valid craftctl commands and project variable handling. Changes include 137 additions and 4 deletions across three files.
73%
#2154 docs: replace occurrences of "charmcraft.yaml" and "recipe" charmcraft merged Merged documentation update replacing charmcraft.yaml and recipe with project or project file across 23 files. Approved by two reviewers after minor clarity feedback. Changes span +155/-159 lines.
72%
#398 docs: fix link to craft cli craft-store merged Merged a documentation fix updating a broken Craft CLI link after a path change. Approved by one reviewer, passed CI checks, and modified one file.
72%
#318 docs: automate CLI reference documentation rockcraft merged Merged automated CLI reference documentation generation. Approved by three reviewers, passed CI checks, and updated five files. Implements CRAFT-1779 to streamline documentation updates.
72%
#2632 docs: update docs to use 26.04 as the generic base charmcraft merged Merged after two approvals and passing CI. Updates documentation to use Ubuntu 26.04 as the generic base, resolving CHARMCRAFT-680. Type checker notifications were informational and non-blocking.
72%
#2700 docs: update tutorial terminal blocks with correct metadata charmcraft merged Merged documentation update standardizing terminal block metadata across tutorial guides. Approved by three reviewers, passed CI, and resolves Jira ticket ISD-5216. Modified six files with 65 line additions.
70%
#97 Rename two methods to explicit that the work is on the terminal (CRAFT-1140). craft-cli merged Merged after approval. Renamed two methods to clarify terminal operations in preparation for captured output work. Refactored four files with no semantic changes.
70%