← Back to issue list

docs: fix some formatting errors in README

View original Github issue

Metadata

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

Current evaluation

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.

Resolution: closed resolved

Reason: The PR itself was merged into main as commit d3d4189 with no unresolved review comments, applying the remaining README spacing fixes. It is a direct follow-up to merged PR #331 (commit de0d308), which fixed the earlier batch of the same formatting errors.

Evaluated by: mr-cal-bot

No scores available.

Issue body

- [ ] Have you followed the guidelines for contributing? - [ ] Have you signed the [CLA](http://www.ubuntu.com/legal/contributors/)? - [ ] Have you successfully run `tox`? --- Gets some more spacing errors that I somehow missed in #331. Oops.

Evaluation history

Date Model Scores Action Summary
stealth/space-bunny-alpha — closed resolved 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.
stealth/space-bunny-alpha — closed resolved Merged as commit d3d4189, adding 10 lines to correct README formatting and spacing errors missed in #331.
qwen/qwen3.6-35b-a3b — — Merged. The pull request corrects formatting and spacing errors in the README file that were missed in a previous update.
qwen3.6-35b-a3b-mtp-q6 — — Merged fixes for README formatting and spacing errors previously missed in PR #331. Changes were integrated into the main branch by maintainer bepri.

Update history

No update history recorded yet.

Related work

  • Related To: canonical/starbase#331 (confidence 92%)

    Prior README spacing fix merged as de0d308; #336 explicitly patches the remaining errors missed by it.

  • Related To: canonical/starbase#397 (confidence 55%)

    Later 'docs: rearrange READMEs' commit7fb5bba restructured the same README (and #365 converted docs to markdown), superseding the file's layout but not this fix.

Related issues

Issue Project State Summary Similarity
#397 docs: rearrange READMEs starbase merged 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.
81%
#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).
78%
#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.
76%
#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.
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%
#331 docs: fix spacing errors in README starbase merged Maintainer bepri merged #331 (de0d308), adding five missing newlines to README.md so literal '#.' markers render as nested ordered sub-lists instead of stray text.
75%
#2488 docs: add PR template charmcraft merged Merged PR #2488 via commit 43e2e993, adding a nine-line Starbase pull request template with contribution, CLA, testing, documentation, and release-note checks.
75%
#639 docs: fix stray space before period in CONTRIBUTING.md starbase merged Merged PR #639 fixing a stray space before a period in CONTRIBUTING.md's conventional-commit guidance, ensuring the correction propagates to all child repositories via starbase sync.
74%
#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.
74%
#607 docs(changelog): update to starbase conventions craft-providers merged Merged PR #607 (commits e2bf0b9, e870c6f, 604233d) refactoring the changelog to starbase conventions: ordered by date, human-readable dates, moved to docs/reference/changelog.rst. Closes #604.
74%