← Back to issue list

docs: rework terminal directives

View original Github issue

Metadata

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

Current evaluation

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.

Resolution: closed resolved

Reason: The PR itself was merged into main as commit a5cfbafb after approval from two reviewers, and it explicitly resolves issue #2563 ('docs: fix usage of terminal directive'), which is now closed. The +43/-119 doc-only diff also removed redundant terminal blocks and updated the sphinx-terminal dependency.

Evaluated by: mr-cal-bot

No scores available.

Issue body

- Remove terminal directives that don't display meaningful output or show an example command interaction - Clean up text around some terminal directives (not really in the scope but I wanted to fix some issues while I was here) - Remove deployment instructions from 'Pack a hooks-based' charm (these were terminal directives so it counts) - Bump `sphinx-terminal` to 1.1.0 Resolves https://github.com/canonical/charmcraft/issues/2563 --- - [X] I've followed the [contribution guidelines](https://github.com/canonical/charmcraft/blob/main/CONTRIBUTING.md). - [X] 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.~~ Planning to refactor most of these pages soon, so this would be wasted effort. ~~I've updated the relevant release notes.~~

Evaluation history

Date Model Scores Action Summary
stealth/space-bunny-alpha — closed resolved 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.
stealth/space-bunny-alpha — closed resolved Docs PR #2870 (merge commit a5cfbafb) merged after approval: reworked Sphinx terminal directives, dropped non-meaningful/empty ones, and bumped sphinx-terminal to 1.1.0. Closes docs issue #2563.
stealth/space-bunny-alpha — closed resolved Merged as a5cfbafb via #2870: terminal directives were cleaned up and sphinx-terminal 1.1.0 adopted, resolving #2563.
qwen/qwen3.6-35b-a3b — — 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.
qwen3.6-35b-a3b-mtp-q6
Impact: 30
Quick Win: 26
Staleness: 10
Complexity: 15
Confidence: 75
needs review Reworks terminal directives in docs: removes unhelpful directives, cleans up text, removes deployment instructions from hooks-based charm docs, bumps sphinx-terminal to 1.1.0. Fresh PR, pending review, CI passing.

Update history

Date Change
updated
updated
updated
updated
created

Related work

  • Related To: canonical/charmcraft#2563 (confidence 97%)

    Issue 'docs: fix usage of terminal directive' explicitly resolved by this merged PR; now closed.

  • Related To: canonical/charmcraft#2810 (confidence 72%)

    Earlier stopgap docs PR ('docs: fix terminal directives') touching the same directive usage in 11 files; #2870 is the fuller rework that supersedes its approach.

Related issues

Issue Project State Summary Similarity
#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.
83%
#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.
81%
#1079 docs: fix terminal directive craft-application merged Merged #1079 in commit 28df6ac7, fixing the terminal directive so its example renders as multiline input.
72%