docs: rearrange READMEs
Metadata
Current evaluation
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.
Suggested action: —
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 |
|---|---|---|---|---|
| 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 issues
| Issue | Project | State | Summary | Similarity |
|---|---|---|---|---|
| #46 docs: split README into one for each action | craft-actions | merged | Merged documentation refactor splitting the monolithic README into individual files for each action. Approved by four reviewers, passed all CI checks, and modified seven files to improve organization and align with recent phrasing updates. | |
| #10 docs: improve README | snapcraft-rocks | merged | Merged documentation update improving the README. Approved by two reviewers, adding 66 lines and removing one across a single file. | |
| #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. | |
| #331 docs: fix spacing errors in README | starbase | merged | Merged documentation changes fixing missing newlines in the README that prevented proper markdown ordered sub-list rendering. Approved by two reviewers, passed CI, and applied with a +5/-0 line change. | |
| #387 docs: add readme template | starbase | merged | Merged after approval by two reviewers and successful CI checks. The pull request introduced a README template, adding 73 lines and removing 7 across two files to standardize project documentation. | |
| #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. | |
| #354 docs: move changlog to docs toplevel directory | craft-parts | merged | Merged a documentation update relocating the changelog to the docs toplevel directory for better discoverability. Approved by one reviewer, passed CI checks, and modified two files. | |
| #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. | |
| #6033 docs: fix broken link in README | snapcraft | merged | Merged a documentation fix that corrects a broken link in the README, resolving issue #6031. The change received approval from two reviewers, passed CI validation, and was integrated into the main branch. | |
| #5586 docs: improve and move setup guides | snapcraft | merged | Merged documentation update improving and relocating setup guides per internal feedback. Approved by two reviewers and passed CI checks. Changes span five files, streamlining contributor onboarding. |