← 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

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.

Suggested action:

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
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 issues

Issue Project State Summary Similarity
#103 docs: update package documentation (CRAFT-37) craft-parts merged Merged documentation updates reorganizing the layout, improving docstrings, and adding lifecycle and class diagrams. Approved by two reviewers, passed CI, and changed 21 files (+511/-83).
81%
#9 docs: update build procedure and fix warning craft-store merged Merged updates consolidate API documentation configuration in conf.py for ReadTheDocs and fix a build warning. Approved by one reviewer, passed CI, and notes propagation to related craft-* projects.
80%
#1199 docs: update README according to template craft-parts merged Merged after two approvals and passing CI. Updates the README to align with a standard template, heavily inspired by Craft Application, modifying one file with 40 additions and 11 deletions.
77%
#114 docs: update readme information debcraft merged Merged after two approvals and passing CI checks. Updates the README with basic usage information consistent with other craft tools, resolving DEBCRAFT-25. Review feedback was incorporated prior to merge.
77%
#1052 docs: Update README.md contributing link rockcraft merged Merged a documentation update fixing a broken contributing link in README.md to point to CONTRIBUTING.md. Approved by three reviewers, passed CI checks, and applied as a single-line change.
76%
#826 docs: update CONTRIBUTING.md craft-application merged Merged documentation update aligning CONTRIBUTING.md with the official template. Approved by three reviewers with all CI checks passing. The change modifies one file with 104 additions and 48 deletions.
75%
#1142 docs: maintain contributing.md craft-parts merged Merged a minor documentation update to contributing.md that corrected an error and improved a step. Approved by two reviewers with all CI checks passing. No changelog entry required.
75%
#416 docs: update contribution links starbase merged Merged documentation update aligning contribution links with Snapcraft. Approved by two reviewers, passed all CI checks, and modified one file with three additions and three deletions.
75%
#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.
74%
#398 docs: fix link to craft cli craft-store merged Merged a documentation fix updating a broken Craft CLI link after a path change. Approved by one reviewer, passed CI checks, and modified one file.
74%