← Back to issue list

docs: update docs subproject readme

View original Github issue

Metadata

Project
starbase
Number
#554
Type
pull request
State
merged
Author
medubelko
Labels
—
Created
Updated
Closed

Current evaluation

PR #554 by medubelko merged as commit 0b67b94, rewriting docs/README.md with corrected, more detailed steps for updating the docs (Sphinx Stack) subproject; approved by 2 reviewers, all CI green.

Resolution: closed resolved

Reason: The documentation-only PR was merged into main as commit 0b67b94 after two rounds of maintainer/reviewer feedback on elaborating the instructions for Craft app contributors. CI (lint, fast/slow tests, security, policy, CLA) passed and the updated docs/README.md is present in the tree.

Evaluated by: mr-cal-bot

No scores available.

Issue body

The instructions were incorrect and out of date. --- - [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`. - [x] 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
stealth/space-bunny-alpha — closed resolved PR #554 by medubelko merged as commit 0b67b94, rewriting docs/README.md with corrected, more detailed steps for updating the docs (Sphinx Stack) subproject; approved by 2 reviewers, all CI green.
stealth/space-bunny-alpha — closed resolved PR #554 (commit 0b67b94) merged to main, rewriting docs/README.md for the docs subproject to correct outdated instructions and elaborate guidance for Craft app contributors.
stealth/space-bunny-alpha — closed resolved Merged PR #554 (commit 0b67b94) updated the docs subproject README to correct outdated instructions and elaborate guidance for Craft app contributors.
qwen/qwen3.6-35b-a3b — — Merged. Updated the docs subproject readme to correct outdated instructions and clarify that the documentation targets craft apps contributors. Approved by reviewers and passed all CI checks.
qwen3.6-35b-a3b-mtp-q6 — — Merged an update to the docs subproject README. Outdated instructions were corrected and the maintainer clarified the documentation targets craft apps contributors, establishing a reliable record for frequent subproject updates.

Update history

No update history recorded yet.

Related work

  • Related To: canonical/starbase#537 (confidence 70%)

    Prior Sphinx Stack 2.0 subproject update that the new README instructions tell contributors to diff against (git log --grep "sphinx stack").

Related issues

Issue Project State Summary Similarity
#562 docs: update to canonical-sphinx craft-providers merged Merged PR (commit 9897239) enabled the canonical-sphinx docs extension and removed sphinx-docs-starter-pack submodule references in craft-providers. Leftover submodule dir was later cleaned up in #713.
73%
#135 docs(deps): update canonical-sphinx craft-archives merged Merged PR #135 updated the canonical-sphinx documentation dependency in commit 8a38995 after two approvals.
73%
#275 build(docs): upgrade to Sphinx Stack 2.0 craft-platforms closed Merged as commit 75dff07, upgrading the documentation configuration and dependencies to Sphinx Stack 2.0 after all CI checks passed.
73%
#10 docs: improve README snapcraft-rocks merged Docs-only PR by maintainer tigarmo rewrote/improved README.rst (+66/-1). Approved by 2 reviewers and merged as squash commit cb40dd2 "docs: improve README (#10)".
73%
#1199 docs: update README according to template craft-parts merged README documentation was updated to match the standard template; PR #1199 was merged via commit ef4d4fff.
73%
#1142 docs: maintain contributing.md craft-parts merged Merged docs PR by maintainer medubelko fixing an error and improving a step in CONTRIBUTING.md (+3/-4 lines). Approved by 2 reviewers, all CI green; landed as commit 14b47207 ('docs: maintain contributing.md (#1142)').
73%
#258 docs: update readme and template, fix build error starbase merged Merged PR #258 in commit 7d2790e, improving README and docs-preparation guidance and disabling PDF/EPUB generation to restore the documentation build.
72%
#497 build(docs): update Sphinx Stack to 2.0 craft-cli merged Merged PR updating documentation tooling to Sphinx Stack 2.0, migrating from .sphinx to docs/_dev, updating conf.py and Makefile, and adding new documentation files. Upstreamed from canonical/starbase#537.
72%
#4367 docs: update sphinx theme snapcraft merged Merged as commit aa64666ef, updating the Sphinx documentation theme; it replaced earlier attempt #4263 and picked up the #4375 fixes that restored broken doc builds.
72%
#346 docs: update README craft-providers merged Docs-only PR by maintainer mr-cal fixing README formatting and adding links; approved and squash-merged into main as commit 889a2cf "docs: update README (#346)" (+7/-2 lines in README.rst).
72%