Skip to content

docs: link the published documentation from the README (3.5) - #37

Merged
alexmond merged 1 commit into
3.5from
docs/readme-docs-link-3.5
Aug 19, 2026
Merged

docs: link the published documentation from the README (3.5)#37
alexmond merged 1 commit into
3.5from
docs/readme-docs-link-3.5

Conversation

@alexmond

Copy link
Copy Markdown
Owner

main got the documentation badge + 📖 line; this branch did not, so readers on this Boot line had no pointer to the docs.

The link targets this branch's own docs version rather than /current/ — a reader on a maintenance branch should land on the docs for the release they are actually using, not the latest Boot line.

Composed from the existing :version: attribute ({version}), which is already maintained per release for the dependency snippets — so this link tracks the branch automatically and cannot go stale.

Adds the docs badge to the badge row and a 📖 Documentation line, matching
the pattern already on main. Points at this Boot line's own docs version
rather than /current/, so readers on this branch get docs for the release
they are actually using.

Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01E5Xq9z5h82reuUpH9BqmR3
@github-actions

github-actions Bot commented Aug 19, 2026

Copy link
Copy Markdown

Test Results

13 files  ±0  13 suites  ±0   17s ⏱️ -1s
78 tests ±0  78 ✅ ±0  0 💤 ±0  0 ❌ ±0 
79 runs  ±0  79 ✅ ±0  0 💤 ±0  0 ❌ ±0 

Results for commit ca2f90c. ± Comparison against base commit b4034ee.

♻️ This comment has been updated with latest results.

@codecov

codecov Bot commented Aug 19, 2026

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.

📢 Thoughts on this report? Let us know!

@alexmond
alexmond merged commit 8b28b7d into 3.5 Aug 19, 2026
6 checks passed
@alexmond
alexmond deleted the docs/readme-docs-link-3.5 branch August 19, 2026 19:39
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant