docs: fix formatting issues
Metadata
Current evaluation
Merged docs formatting fixes for local documentation builds in charmcraft#2299 via commit 5ffb80fe; two files changed (+3/-1).
Resolution: closed resolved
Reason: PR #2299 was approved and merged, resolving the documentation formatting errors with commit 5ffb80fe.
Evaluated by: mr-cal-bot
No scores available.
Issue body
I was getting errors when building the docs locally. This PR fixes the issues.
Evaluation history
| Date | Model | Scores | Action | Summary |
|---|---|---|---|---|
| stealth/space-bunny-alpha | — | closed resolved | Merged docs formatting fixes for local documentation builds in charmcraft#2299 via commit 5ffb80fe; two files changed (+3/-1). | |
| stealth/space-bunny-alpha | — | closed resolved | Merged charmcraft PR #2299, fixing documentation formatting errors that broke local docs builds; two files changed (+3/-1). | |
| qwen/qwen3.6-35b-a3b | — | — | Merged documentation formatting fixes resolving local build errors. Approved by two reviewers with minimal changes (+3/-1 across two files). Merged despite failing snap-build CI checks. | |
| qwen3.6-35b-a3b-mtp-q6 | — | — | Merged external changes resolving documentation formatting errors that prevented local builds. The fix was accepted and integrated without additional review comments. |
Update history
No update history recorded yet.
Related issues
| Issue | Project | State | Summary | Similarity |
|---|---|---|---|---|
| #2186 docs: fix build errors | charmcraft | merged | Merged as charmcraft/charmcraft#2186 in commit 42f42bd2, fixing the targeted docs build error. Remaining transclusion problems were addressed separately in canonical/craft-parts#1021. | |
| #2734 docs: improve versioning logic | charmcraft | merged | Merged as 5fb6af27, updating docs versioning so the unversioned/latest documentation is labeled “Charmcraft dev documentation.” | |
| #2832 docs: fix version string for 4.x | charmcraft | merged | Merged #2832 corrected docs title versioning for Charmcraft 4.x: local, PR, and branch builds show major/minor; the latest branch shows dev. | |
| #2010 docs: add, refactor, and reformat discourse docs feat. charmcraft | charmcraft | merged | Merged PR #2010 as commit a1a3d4b1, migrating Charmcraft content to RTD-ready docs, reformatting it, and separating Ops-related material. | |
| #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. | |
| #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. | |
| #2966 docs: fix spelling errors and Vale linting failures | charmcraft | merged | Merged PR #2966 to fix documentation spelling errors and Vale linting failures in charmcraft, correcting typos in howto guides and updating `.custom_wordlist.txt`. | |
| #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. | |
| #2154 docs: replace occurrences of "charmcraft.yaml" and "recipe" | charmcraft | merged | Merged PR #2154 (a6ccb3d4) updated 23 documentation files to use “project” or “project file” instead of “charmcraft.yaml” and “recipe.” | |
| #2795 docs: improve `charmcraft clean` command documentation | charmcraft | closed | Closed unmerged; maintainer @lengau rejected the proposed charmcraft clean documentation as subpar, and no documentation commit or replacement PR landed. |