← Back to issue list

Docs: Harmonize README with template

View original Github issue

Metadata

Project
rockcraft
Number
#668
Type
issue
State
closed
Author
medubelko
Labels
—
Created
Updated
Closed

Current evaluation

Rockcraft's README was harmonized with the Craft project template by merged PR canonical/rockcraft#881 (commit dc33814c, +90/-189). Maintainer medubelko closed #668 on 2025-09-13 citing that PR.

Resolution: closed resolved

Reason: PR #881 'docs: harmonize readme with template' was merged as commit dc33814c, rewriting README.rst from the Craft project template after autoformat fixes. The issue author then closed the issue citing PR #881.

Evaluated by: mr-cal-bot

No scores available.

Issue body

### Request type Enhancement ### What needs to get done The README is incomplete, and we should be harmonizing all of them across craft projects. For now, we can rewrite it using the template in https://github.com/canonical/starbase/issues/233, and leave the build section blank while @sergiusens polishes it. ### Documentation location README ### Additional information Depends on https://github.com/canonical/starbase/issues/233.

Evaluation history

Date Model Scores Action Summary
stealth/space-bunny-alpha — closed resolved Rockcraft's README was harmonized with the Craft project template by merged PR canonical/rockcraft#881 (commit dc33814c, +90/-189). Maintainer medubelko closed #668 on 2025-09-13 citing that PR.
stealth/space-bunny-alpha — closed resolved README harmonized with the project template by merged PR canonical/rockcraft#881, commit dc33814c.
qwen/qwen3.6-35b-a3b — — README updated to match the canonical/starbase template. Issue closed after resolution via pull request #881, which implemented the standardized documentation structure.
qwen/qwen3.6-35b-a3b — — The README was updated to align with the canonical/starbase template. The enhancement was resolved and merged via pull request #881 in the rockcraft repository.
qwen/qwen3.6-35b-a3b — — README harmonization with the canonical/starbase template was completed. The enhancement was resolved and closed after merging pull request #881 in the rockcraft repository.
qwen3.6-35b-a3b-mtp-q6 — — Updated the README to align with the canonical/starbase template. Resolved and merged via pull request #881 in the rockcraft repository.

Update history

No update history recorded yet.

Related work

  • Likely Fixed By: canonical/rockcraft#881 (confidence 98%)

    Merged PR that rewrote README.rst using the Craft project template; commit dc33814c.

  • Blocked By: canonical/starbase#233 (confidence 80%)

    Upstream README template issue in starbase the work depended on; resolved by starbase PR #387 (commit afc6663).

Related issues

Issue Project State Summary Similarity
#881 docs: harmonize readme with template rockcraft merged Merged as dc33814c: harmonized Rockcraft's README with the project template (+90/-189, 3 files); reviewer flagged linting, fixed via make autoformat, all CI checks green.
89%
#4957 Docs: Harmonize README with template snapcraft closed README was harmonized with the Craft model in commit f4d43dcdb (docs: align readme with model), fulfilling the requested documentation cleanup before closure.
82%
#775 docs: apply release-notes template to rockcraft rockcraft merged Merged #775 in commit 89aad735, rendering Starbase's release-notes template for Rockcraft and adding 257 lines across three documentation files.
74%
#247 docs: include some docs from craft-parts rockcraft closed PR pulling craft-parts docs into rockcraft was left unmerged and closed as redundant; the same docs refactor landed instead via rockcraft#515 (commit 5c2263f1, "refactor(docs): use more docs from craft-parts").
73%
#1035 docs: add docs items to PR template rockcraft merged Merged in canonical/rockcraft#1035 (commit 051f40ba), adding documentation checklist items and a CONTRIBUTING.md link to the PR template.
72%
#611 chore: point README to doc.ubuntu.com/rockcraft rockcraft merged Merged rockcraft PR #611 (commit ce0636d1), a 3-line docs chore changing the README's documentation link to point at doc.ubuntu.com/rockcraft instead of the previous URL.
72%
#254 docs: include contribution information rockcraft merged Merged contribution documentation updates in rockcraft#254 via commit 24e0c3ab, changing 4 files (+84/-34) and approved by three reviewers.
71%
#233 Docs: Add README template starbase closed Added the Craft project README template in merged PR canonical/starbase#387 (commit afc6663), covering Markdown setup, installation, builds, licensing, and contribution links.
71%
#634 feat: use versioned form of doc urls rockcraft merged Merged PR #634 updated Rockcraft error messages and init templates to use versioned documentation URLs, including the running version in links.
70%
#515 refactor(docs): use more docs from craft-parts rockcraft merged Merged #515 refactored Rockcraft docs to reuse Craft Parts pages via direct TOC links or local includes (commit 5c2263f1).
70%