← 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

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.

Resolution: closed resolved

Reason: The PR itself was the change and it was merged into main after review approval with all checks passing; it corrected terminal directive usage across 11 docs files. No further code fix was needed.

Evaluated by: mr-cal-bot

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
stealth/space-bunny-alpha — closed resolved 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.
stealth/space-bunny-alpha — closed resolved Merged PR #2810, correcting terminal directive rendering across 11 documentation files as a stopgap until CHARMCRAFT-684 is completed.
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
#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.
81%
#2563 docs: fix usage of terminal directive charmcraft closed 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.
78%
#1079 docs: fix terminal directive craft-application merged Merged #1079 in commit 28df6ac7, fixing the terminal directive so its example renders as multiline input.
74%
#2787 docs: fix versioning logic charmcraft merged Merged PR canonical/charmcraft#2787 by maintainer jahn-junior fixes the version name used for branch-based docs builds (1 file, +1/-2); approved by 1 reviewer, all CI checks passed.
72%
#2347 docs: fix tree in init command docstring charmcraft merged Merged in canonical/charmcraft#2347 (a8da011a), fixing Sphinx rendering of the init command file tree and removing a dead Juju link; 80-column line length remains unchanged.
71%