docs: resolve `docs-lint` issues
Metadata
Current evaluation
Merged after resolving documentation linting issues. Excluded docs/_dev/ from Sphinx linting and updated link checker timeout. Passed all CI checks, received approval, and was successfully integrated.
Suggested action: —
No scores available.
Issue body
* Ignore the `docs/_dev/` directory when running the Sphinx linter
* Configure the link checker to use the more modern timeout reporting
---
- [X] I've followed the [contribution guidelines](https://github.com/canonical/starbase/blob/main/CONTRIBUTING.md).
- [X] I've signed the [CLA](http://www.ubuntu.com/legal/contributors/).
- [X] 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.
Evaluation history
| Date | Model | Scores | Action | Summary |
|---|---|---|---|---|
| qwen/qwen3.6-35b-a3b | — | — | Merged after resolving documentation linting issues. Excluded docs/_dev/ from Sphinx linting and updated link checker timeout. Passed all CI checks, received approval, and was successfully integrated. | |
| qwen3.6-35b-a3b-mtp-q6 | — | — | Merged to resolve docs-lint issues. Changes ignore the docs/_dev/ directory during Sphinx linting and update the link checker to use modern timeout reporting. All lint and test checks passed. |
Update history
No update history recorded yet.
Related issues
| Issue | Project | State | Summary | Similarity |
|---|---|---|---|---|
| #513 build(docs): fix double build with docs-lint | starbase | merged | Merged a one-line fix resolving a double build issue during docs-lint by correcting a mistaken assumption about Sphinx's linter requirements. Approved by two reviewers, passed CI, and closed issue #512. | |
| #983 docs: update links | rockcraft | merged | Merged documentation update that replaces hardcoded URLs with intersphinx and Sphinx references, and fixes redirected external links. Approved by three reviewers and passed CI checks after resolving initial lint and test failures. | |
| #17 ci: update docs CI | craft-application | merged | Documentation CI configuration updated and merged to resolve Sphinx linting failures. Approved by one reviewer with passing CI checks. Changes span four files with 17 additions and 5 deletions. | |
| #4358 style(docs): fix linter errors for auto-generated commands | snapcraft | merged | Merged via rebase-and-merge after two approvals and passing CI. Fixed linter errors in auto-generated documentation by ensuring docs are built prior to linting. Modified 5 files with negligible coverage impact. | |
| #1104 docs: update links | craft-parts | merged | Merged after two reviewers approved. Updated documentation to fix broken links. Integrated into the main branch despite some CI test failures. | |
| #291 docs: fix linkcheck issues with documentation | craft-store | merged | Merged after approval and passing all CI checks. Resolved documentation linkcheck issues by fixing broken links, addressing issue #290. Changes modified two files with five additions and two deletions. | |
| #2128 docs: add anchors and fix a few small things | charmcraft | merged | Merged documentation updates adding intersphinx anchors, renaming sections for consistency, fixing rendering issues, and resolving linting errors. Approved by reviewers and integrated after manual fixes. | |
| #136 docs: bring all starter pack documentation checks into docs lint | starbase | closed | Integrated Canonical Sphinx docs starter pack linters (Woke, linkcheck, pyspelling) into the documentation lint workflow. Resolved and merged via pull request #478. | |
| #98 ci: lint docs in all directories | starbase | merged | Merged into main. Configured CI to run sphinx-lint on all rst files across the repository. Approved by reviewer, passed all checks, and merged with zero coverage impact. | |
| #103 docs: new link to docs | craft-store | merged | Merged after approval. Updated README.md to add a documentation link and badge, resolving issue #101. The single-file change added three lines and removed one. The pull request passed review and CI checks without blocking the merge. |