docs: revise tone — positive framing, fewer callouts, kit-first#321
Merged
Conversation
…tation
Sweeping editorial pass over `docs/` and `devframe/docs/`:
- Describe what *is* rather than what isn't; drop "X is for Y, not Z"
constructions and roadmap phrases ("not yet implemented", "dev mode
planned") in favour of present-tense scope.
- Reserve callouts for genuinely critical material — keep `[!WARNING]`
for experimental APIs and security/leakage hazards (added one to
remote-client URL token handling), fold `[!NOTE]` / `[!TIP]` content
into prose.
- In `/docs/`, lead examples with the Vite-plugin / Kit path and treat
DevFrame as the underlying foundation referenced where relevant.
- Tighten intros, trim redundant cross-links, and shorten section
headings.
Records the four guidelines in AGENTS.md so future doc edits follow the
same conventions.
Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
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.
Description
Sweeping editorial pass over
docs/anddevframe/docs/(29 files; -808/+690 lines):[!WARNING]for genuinely critical material — kept on experimental APIs, added one to remote-client URL token leakage. Folded[!NOTE]/[!TIP]content into prose./docs/. Lead examples with the Vite-plugin / Kit path; treat DevFrame as the underlying foundation referenced where relevant.AGENTS.mdrecords the four guidelines so future doc edits follow the same conventions.Linked Issues
None.
Additional context
pnpm -C devframe/docs run docs:buildpasses cleanly. The mainpnpm -C docs run docs:buildfails on a pre-existing config issue (the import indocs/.vitepress/config.tsreferencesdevframe/docs/.vitepress/sidebar, which was removed in #316; the corresponding fix was inadvertently reverted in #317). Out of scope for this PR — flagging for a follow-up.🤖 Generated with Claude Code