← 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

README updated to match the canonical/starbase template. Issue closed after resolution via pull request #881, which implemented the standardized documentation structure.

Suggested action: —

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
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.
qwen3.6-35b-a3b-mtp-q6 — — Fixed via pull request #881 in canonical/rockcraft, which harmonized the README with the standard template.

Update history

No update history recorded yet.

Related issues

Issue Project State Summary Similarity
#1929 Docs: Harmonize README with template charmcraft open Task to harmonize craft project READMEs with the starbase template. Dependency starbase#233 is closed, and charmcraft's README was aligned with the model in PR #2283, but the issue remains open with no maintainer activity since 2024-09.
83%
#233 Docs: Add README template starbase closed Resolved by merging PR #387 in canonical/starbase. A standardized Markdown README template for craft projects was implemented, covering installation, build steps, and licensing requirements.
80%
#4957 Docs: Harmonize README with template snapcraft closed Closed without implementation. The README harmonization request was abandoned after an internal Jira ticket was created. No code changes or merges occurred.
77%
#93 README.rst template starbase closed Implemented a consistent README.rst template for project inheritance. Resolved via pull request #387 in the canonical/starbase repository.
75%
#785 fix: remove Starbase README craft-application merged Merged a pull request that removes the Starbase README file from the .github directory. Approved by two reviewers, the change was merged after passing most CI checks, deleting 144 lines across one file.
73%
#6 docs: Bring basic docs structure from starbase craft-archives merged Merged into main after addressing reviewer feedback. Added a basic documentation structure from starbase across seven files (+158 lines). Initially a draft, it was approved and merged to establish a starting point for project documentation.
72%
#456 docs: use folders for each axis craft-cli merged Merged documentation restructuring that organizes Reference, Tutorials, and Explanation into folders. Added link redirects and fixed a docs build issue for the Starbase update. Approved by two reviewers with all CI checks passing.
71%
#2488 docs: add PR template charmcraft merged Merged addition of a standard PR template from Starbase. Approved by two reviewers with zero unresolved comments. The nine-line documentation update was integrated despite some failing fast tests and non-blocking type checker warnings.
71%
#152 Integrate Starbase's top-level project docs craft-cli closed Closed without implementation. The requested README update and HACKING document port were not completed, indicating the task was abandoned or superseded.
70%
#157 docs: use rtd config from starbase craft-archives merged Merged to update the ReadTheDocs configuration from starbase, fixing documentation build failures. Approved by two reviewers and integrated after passing CI checks.
70%