`charmcraft init` tree of files and directories styling issue
Metadata
Current evaluation
Fixed and deployed the charmcraft init file-tree documentation in merged PR #2347 (commit a8da011a), improving tree styling and preventing description line breaks.
Resolution: closed resolved
Reason: PR #2347 corrected the init command docstring tree rendering and whitespace handling in commit a8da011a. The maintainer confirmed the fix was deployed before closing the issue.
Evaluated by: mr-cal-bot
No scores available.
Issue body
### Request type
Fix
### What needs to get done
The following tree diagram of files and directories created using `charmcraft init` requires some CSS to make it readable.
Currently, there is not styling applied to the block therefore a user would not be able to recognise that this is supposed to be a tree of files.
With appropriate styling, the block can display the tree in a recognisable way
Applying `white-space: pre` provides a temporary solution, but as you can see in the images, the description causes line breaks. This needs to be addressed as well.
### Documentation location
https://canonical-charmcraft.readthedocs-hosted.com/latest/reference/commands/init/#ref-commands-init
### Additional information
UX Issue
Evaluation history
| Date | Model | Scores | Action | Summary |
|---|---|---|---|---|
| stealth/space-bunny-alpha | — | closed resolved | Fixed and deployed the charmcraft init file-tree documentation in merged PR #2347 (commit a8da011a), improving tree styling and preventing description line breaks. | |
| stealth/space-bunny-alpha | — | closed resolved | Fixed charmcraft init’s file-tree documentation in PR #2347, including whitespace and line-break handling; the fix was deployed and the issue closed. | |
| qwen3.6-35b-a3b-mtp-q6 | — | — | CSS styling for the charmcraft init file tree output was fixed and deployed via PR #2347. Adjustments resolve formatting and line break issues, ensuring the directory structure displays correctly. The issue is closed. | |
| qwen/qwen3.6-35b-a3b | — | — | Fixed CSS styling for the charmcraft init file tree to ensure proper readability. The resolution was merged via PR 2347 and deployed, closing the issue. | |
| qwen/qwen3.6-35b-a3b | — | — | The charmcraft init file tree lacked CSS styling, causing unreadable output. A fix was implemented via pull request 2347 and deployed, resolving the styling issue and closing the report. | |
| qwen3.6-35b-a3b-mtp-q6 | — | — | Fixed and deployed via PR 2347. Applied CSS styling to properly format the charmcraft init file tree output, resolving the readability issue. |
Update history
No update history recorded yet.
Related work
-
Likely Fixed By:
canonical/charmcraft#2347
(confidence 100%)
Merged as commit a8da011a with the title "docs: fix tree in init command docstring".
Related issues
| Issue | Project | State | Summary | Similarity |
|---|---|---|---|---|
| #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. | |
| #471 config: add charm part to documentation (CRAFT-356) | charmcraft | merged | Merged PR #471 via commit e0b18661, documenting the charm part in the configuration schema for CRAFT-356. | |
| #2299 docs: fix formatting issues | charmcraft | merged | Merged docs formatting fixes for local documentation builds in charmcraft#2299 via commit 5ffb80fe; two files changed (+3/-1). | |
| #91 First pass at 'charmcraft init' | charmcraft | merged | Merged PR #91 delivered the first non-interactive charmcraft init scaffolding implementation; README improvements, extra options, and prompts were deferred (commit 0ebd9f87). | |
| #2748 docs: improve charm naming docs, with links to detailed guidance | charmcraft | merged | Docs PR #2748 merged (commit 0389aeb4): rewrote charm naming guidance in the charmcraft.yaml reference and manage-charms how-to, replacing inline best-practice notes with links to the Ops docs. Fixes #2582; relied on canonical/operator#2610. | |
| #188 Small text cleanups for README and charmcraft help | charmcraft | merged | Merged README and charmcraft help-text cleanups in ffc44697, updating 13 files after approval by two reviewers. |