← Back to issue list

docs: rearrange READMEs

View original Github issue

Metadata

Project
starbase
Number
#397
Type
pull request
State
merged
Author
bepri
Labels
—
Created
Updated
Closed

Current evaluation

Merged docs-only PR moving Starbase's rendered README into .github/README.md and the generic template to the root README.md, clarifying the future update workflow. All CI checks passed.

Resolution: closed resolved

Reason: PR canonical/starbase#397 was merged as commit 7fb5bba ("docs: rearrange READMEs (#397)"), confirmed by the commit history for .github/README.md. The diff swapped the two README files, and the current top-level README.md still holds the generic template content.

Evaluated by: mr-cal-bot

No scores available.

Issue body

- [x] Have you followed the guidelines for contributing? - [x] Have you signed the [CLA](http://www.ubuntu.com/legal/contributors/)? - [x] Have you successfully run `make lint && make test`? --- The merging process for starbase can get a little bit confusing with multiple READMEs present and inaccurate names. Thankfully, Github will prioritize rendering a README in the `.github/` directory, so Starbase's README will live in there while the "template" README will live at the top-level. The intended workflow moving forward will then be to simply delete the README in `.github/` and adapt the template accordingly.

Evaluation history

Date Model Scores Action Summary
stealth/space-bunny-alpha — closed resolved Merged docs-only PR moving Starbase's rendered README into .github/README.md and the generic template to the root README.md, clarifying the future update workflow. All CI checks passed.
stealth/space-bunny-alpha — closed resolved Merged docs: rearrange READMEs: moved Starbase’s rendered README to .github/ and the template to the root, clarifying the future documentation workflow. Approved with all CI checks passing.
qwen/qwen3.6-35b-a3b — — Merged documentation update rearranging READMEs to clarify the fork workflow. The main README was moved to .github/ for GitHub rendering priority, while the template stays at the root. Approved by two reviewers and passed all CI checks.

Update history

No update history recorded yet.

Related work

  • Related To: canonical/starbase#93 (confidence 62%)

    Earlier issue requesting a consistent README template, delivered by PR #387; #397 reorganises where that template lives.

Related issues

Issue Project State Summary Similarity
#336 docs: fix some formatting errors in README starbase merged Docs-only PR merged as commit d3d4189, adding 10 lines to starbase's README to fix spacing/formatting errors that slipped past the earlier README cleanup in #331 (commit de0d308). Approved by 2 reviewers, no CI.
81%
#140 docs: use the Starbase README template craft-platforms merged Merged PR #140 adopted the Starbase README template, adding GitHub badges requested in #89; landed as commit 376010f with all CI checks passing.
78%
#2283 docs: align README with model charmcraft merged Docs-only PR merged as commit 12308dde ("docs: align README with model (#2283)"): rewrote README to match canonical/starbase README template and dropped unused Craft Parts docs, fixing local build errors. 2 files, +79/-49.
78%
#76 docs: remove duplicate readthedocs yaml craft-archives merged PR #76 merged as commit fd9fac8, deleting the redundant .readthedocs.yml left over from the starbase merge and keeping starbase's upstream .readthedocs.yaml.
77%
#785 fix: remove Starbase README craft-application merged PR #785 merged as commit d6b706a3, deleting the 144-line Starbase-rendered .github/README.md from craft-application. Approved by 2 reviewers; lint/tests/builds passed (OSV-scanner failed, non-blocking).
76%
#2353 docs: update `CONTRIBUTING.md` charmcraft merged Docs-only PR #2353 merged as commit 62abb2f4, replacing CONTRIBUTING.md with shared Starcraft guidance (+257/-58 across 2 files) and dropping a misplaced README link; approved by 2 reviewers.
75%
#1929 Docs: Harmonize README with template charmcraft open README harmonization with Starbase template. Blocking dependency starbase#233 closed; PR #2283 aligned README with the model. Work appears complete but issue remains open.
74%
#93 README.rst template starbase closed Added a reusable README template and related documentation updates in canonical/starbase#387 (commit afc6663).
74%
#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.
74%
#156 docs: update main project docs craft-cli merged Docs PR merged as commit 74150b7 by maintainer tigarmo: restored Starbase's HACKING.rst and updated README to point at it, ahead of the 2.0.0 release. HACKING.rst later gave way to CONTRIBUTING.md.
73%