← Back to issue list

docs: fix formatting issues

View original Github issue

Metadata

Project
charmcraft
Number
#2299
Type
pull request
State
merged
Author
dwilding
Labels
Created
Updated
Closed

Current evaluation

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.

Suggested action:

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
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.
qwen3.6-35b-a3b-mtp-q6 Merged an external contribution resolving local documentation build failures caused by formatting issues. Changes were accepted and integrated into the codebase.

Update history

No update history recorded yet.

Related issues

Issue Project State Summary Similarity
#919 docs: fix indentation craft-application merged Merged documentation fix correcting an indentation error introduced in a prior review. Approved by two reviewers, passed all CI checks, and applied a minimal two-line change.
80%
#1063 docs: fix a missing link rockcraft merged Merged a documentation fix adding a missing hyperlink. Approved by four reviewers with a single-line change. The PR was merged despite one failing CI check (snap-tests), as the documentation-only update was deemed low-risk.
79%
#2280 docs: resolve local build errors charmcraft merged Merged. Resolved local documentation build failures by adding files causing undefined substitution and toctree warnings to the exclude_patterns list. Approved by two reviewers and passed CI.
79%
#331 docs: fix spacing errors in README starbase merged Merged documentation changes fixing missing newlines in the README that prevented proper markdown ordered sub-list rendering. Approved by two reviewers, passed CI, and applied with a +5/-0 line change.
79%
#236 docs: revise issue templates imagecraft merged Merged revision of issue templates to align with Snapcraft. Approved by two reviewers and passed most CI checks. Updated three files to incorporate template changes.
77%
#2649 docs: format doc version as major.minor charmcraft merged Merged a documentation update that formats version strings as major.minor. Approved by three reviewers and merged despite a failing typecheck CI, modifying a single file.
77%
#412 docs: fix list syntax craft-parts merged Merged documentation update correcting list syntax errors introduced in a previous commit. Approved by one reviewer with zero unresolved comments. Modified one file (+15/-14 lines).
77%
#2222 style: fix linting issues charmcraft merged Merged following approval by two reviewers. Resolved linting issues across three files with minor style adjustments (+8/-9 lines). No review comments or CI checks were required.
76%
#258 docs: update readme and template, fix build error starbase merged Merged after two reviewer approvals and passing CI. Updated README wording, added doc preparation details, and disabled PDF and EPUB generation to resolve build errors. All changes passed tests with 100% coverage.
76%
#250 docs: fix markup rockcraft merged Merged after two approvals and passing CI. Documentation markup was corrected and linting issues resolved. Changes were split across multiple PRs for scope management, with this one containing the initial approved fixes.
76%