Phrasing, formatting, and link cleanups across docs#446
Draft
cb341 wants to merge 1 commit intofeature/improve-docsfrom
Draft
Phrasing, formatting, and link cleanups across docs#446cb341 wants to merge 1 commit intofeature/improve-docsfrom
cb341 wants to merge 1 commit intofeature/improve-docsfrom
Conversation
cb341
force-pushed
the
feature/docs-phrasing
branch
2 times, most recently
from
7f16664 to
35c0308
Compare
cb341
force-pushed
the
feature/improve-docs
branch
from
9384c0e to
fd20e49
Compare
cb341
force-pushed
the
feature/docs-phrasing
branch
2 times, most recently
from
5717f1f to
94353bd
Compare
Convert every blockquote-style note/warning/tip/important into the GitHub `> [!XXX]` form so the docs render consistently: - `> **Note:**` / `> _Note_:` / `**Note:**` → `> [!NOTE]` - `>⚠️ ...` / `:warning:`-bracketed callouts → `> [!WARNING]` - `> :exclamation:` / `**:exclamation:` → `> [!IMPORTANT]` - `> :bulb:` → `> [!TIP]` - `> ⭐️` template-provided markers and `> ✨` Rails-default markers (semantically informational) → `> [!NOTE]` - `ℹ️ _..._` → `> [!NOTE]` Decorative emoji in headings, links, and celebratory inline lines (e.g. `:tada:`, `:fire:`, `:gem:`) are out of scope here and live in feature/emoji-cleanup. Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
cb341
force-pushed
the
feature/docs-phrasing
branch
from
94353bd to
462f54e
Compare
cb341
force-pushed
the
feature/improve-docs
branch
from
f9fa4de to
de963c5
Compare
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Mechanical cleanups across the markdown sources: align table padding in the README template, fix the mbook→mdbook typo, convert bare URLs to auto-links, normalise note callouts to blockquoted Note: form, replace --> arrows with →, and add code formatting around [project-name] placeholders. Pin mdbook-version to 0.4.40 in CI to avoid drift from 'latest'.