Skip to content

docs: rewrite documentation in plain English - #135

Merged
ueberBrot merged 1 commit into
mainfrom
docs/plain-english-guidance
Oct 11, 2026
Merged

ueberBrot merged 1 commit into
mainfrom
docs/plain-english-guidance

Conversation

@ueberBrot

Copy link
Copy Markdown
Owner

Summary

Rewrite 92 documentation files in plain English with shorter sentences and no prose em dashes or en dashes. Keep ADRs and the shipped skill focused on agent instructions.

README.md, GLOSSARY.md, .changeset/README.md   package and release guidance
apps/docs/src/content/docs/                  usage documentation
docs/adr/                                   agent-facing decisions
skills/effect-api-query/                     shipped agent guidance
_artifacts/                                 coverage record and domain map
.intent/review-state.json                    completed maintenance reviews

Apply Humanizer, Simple English, and Technical Writing without installing them. Use writing-for-agents for ADRs and the shipped skill. Leave .agents/, docs/agents/, and AGENTS.md unchanged.

Evidence

  • Before: 15 prose em dashes or en dashes across the edited documentation.
    After: Zero. All 113 code blocks, link targets, and heading anchors are unchanged.
  • Before: Dense explanations of query utilities, cache ownership, and client lifetime.
    After: Direct steps and shorter explanations. vp run --no-cache docs-build passes the excerpt checks, Astro checks, site build, and internal links. vp run --no-cache api-types passes with TypeScript 7 and 5.9.
  • Before: Maintenance records describe the prior guidance.
    After: The domain map and coverage record reflect this rewrite. vp exec intent maintainer check reports no pending items. vp run skills-check, vp run --no-cache format, and git diff --check pass.

Merge Danger

Door: two-way

The documentation commit can be reverted. No Changeset is required for this documentation-only change.

Blast Radius: Documentation

Readers and agents receive revised wording. Runtime behavior, public types, executable examples, and dependency ranges are unchanged.

@changeset-bot

changeset-bot Bot commented Oct 11, 2026

Copy link
Copy Markdown

⚠️ No Changeset found

Latest commit: 4b881dd

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

@ueberBrot
ueberBrot merged commit fac2c2f into main Oct 11, 2026
6 checks passed
@ueberBrot
ueberBrot deleted the docs/plain-english-guidance branch October 11, 2026 19:32
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