docs: apply the instructional-prose audit to the page trees - #20
Merged
Conversation
An audit of every rendered docs page against the site's instructional-writing mechanics graded the corpus clean on most checks and surfaced a concentrated defect set: chronology and novelty markers on deployment-status sentences, difficulty minimizers, future tense on standing behavior, third-person reader address, bare see-below references, four dangling cross-references whose quoted section titles carried no link, and two counts that contradict the list or command they introduce. This applies the accepted rewrites. No rewrite changes a technical claim, and the link fixes follow the tree's own relative-path convention with anchors verified against the target headings.
There was a problem hiding this comment.
Pull request overview
Applies the instructional-prose audit rewrites across the documentation corpus, focusing on tightening instructional language, removing ambiguity (chronology/future-tense markers, minimizers, see-below references), and converting dangling cross-references into explicit links—without changing technical claims.
Changes:
- Updates instructional steps and phrasing to be more direct and consistent across sibling pages.
- Replaces bare/dangling references with explicit intra-repo links (including specific anchors where applicable).
- Fixes a few small consistency issues in descriptions (e.g., count/wording adjustments, clarified “see …” targets).
Reviewed changes
Copilot reviewed 27 out of 27 changed files in this pull request and generated no comments.
Show a summary per file
| File | Description |
|---|---|
| tutorials/first-collection.md | Updates Step 3 wording to match the actual install command (three packages). |
| skills/atomic-integration/SKILL.md | Rewrites a few sentences for clarity and converts several inline refs to clickable links. |
| reference/validation.md | Minor wording adjustments in the validation ledger entries for the SDK pages. |
| reference/sdk/atomicassets.md | Tightens phrasing around behavior statements (no technical changes). |
| reference/media.md | Converts a previously indented paragraph to a normal paragraph for consistent instructional prose. |
| reference/chain.md | Rephrases guidance on handling error 3060002 to be more direct. |
| reference/atomicmarket/tables.md | Fixes previously dangling cross-references by adding explicit links to the relevant section. |
| reference/atomicmarket/fees-and-royalties.md | Rephrases an instruction to imperative voice (“Store these…”). |
| reference/atomicmarket/actions.md | Fixes dangling cross-references by linking to the specific RAM section anchor. |
| reference/atomicassets/v2-upgrade.md | Removes chronology markers while keeping the same validated deployment-status claim and check date. |
| reference/atomicassets/tables.md | Tightens deployment-status sentence while keeping the same meaning. |
| reference/atomicassets/structure.md | Minor voice/tense adjustment for the notify-accounts bullet. |
| reference/atomicassets/notifications.md | Tightens phrasing in “cannot assume” section and removes chronology marker in live-chain note. |
| reference/atomicassets/data-precedence.md | Clarifies that the precedence ordering reflects the atomicassets-api reference reader’s choice. |
| reference/atomicassets/actions.md | Tightens wording and updates one “see below” style reference to point to the relevant note. |
| reference/atomicassets-api.md | Adjusts imperative wording for local verification guidance. |
| reference/api.md | Clarifies one cross-reference and removes a “see above” pointer in favor of an explicit section name. |
| guides/testing-with-vert.md | Normalizes phrasing and list formatting; clarifies chain naming (“WAX testnet”). |
| guides/sales.md | Replaces “see below”/implicit references with explicit section names. |
| guides/querying-the-api.md | Updates the stated count of behaviors to match the list and switches to more direct instructional phrasing. |
| guides/offers.md | Replaces “see below”/implicit references with explicit section names and normalizes list formatting. |
| guides/notification-integration.md | Tightens the “trap” explanation to avoid redundancy while preserving meaning. |
| guides/links.md | Tightens cancellation behavior wording (no behavior change described). |
| guides/deposits.md | Normalizes list formatting and tightens wording about mainnet status. |
| guides/buyoffers.md | Removes chronology markers (“currently”) and replaces implicit references with explicit section names. |
| guides/auctions.md | Replaces an implicit “see below” with a named section reference. |
| guides/asset-lifecycle.md | Removes a formatting emphasis marker while keeping the same “Changed in V2” content. |
💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.
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
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.
Why
The docs site's prose standard gained instructional-writing mechanics, and an audit of every rendered page graded the corpus against them. The corpus came back clean on most checks; what remained concentrates in a few classes: chronology and novelty markers on deployment-status sentences, difficulty minimizers, future tense on standing behavior, third-person reader address where sibling pages use imperatives, bare see-below references, four dangling cross-references whose quoted section titles carried no link, and two counts that contradict the list or command they introduce. This applies the accepted rewrites. No rewrite changes a technical claim.
Validation
All nine statically runnable CI checks pass locally with the exact pinned tool versions: links and anchors (lychee, 257 OK each, fragments resolved), frontmatter (50 pages schema-valid), banned terms, prose bans, spelling (typos 1.49.0), casing, validation consistency (38 graded pages, 37 ledger rows, 16 baselines), and markdownlint (62 files). The starters job needs live testnet signing and this diff never touches starters. A cold prose review of the diff returned one finding (jungle4 casing), folded in.