Skip to content

2606110639_website-docs-audience-split.md

Latest commit

 

History

History
74 lines (62 loc) · 2.5 KB

2606110639_website-docs-audience-split.md

File metadata and controls

74 lines (62 loc) · 2.5 KB
Raw
id 2606110639
title Audience split for website-published docs
status ✅
summary Remove maintainer- and agent-facing content from every website-published doc page and rehome it in repo-only trees.

Audience split for website-published docs

Goal

Every page that reaches mdsmith.dev serves users only. Maintainer- and agent-facing material lives in repo-only trees instead.

Scope

The website sync publishes these pages:

The repo-only trees (docs/development, docs/research, docs/security, docs/brand, plan/) hold contributor and agent content. A deep-dive link from a published page into a repo-only tree is fine. The sync rewrites such links to GitHub URLs.

Out of scope: full prose rewrites. The review lens is the audience split. Wording changes only where content moves or a plan reference is replaced.

Tasks

  1. Triage every published page for maintainer- or agent-facing content; record per-file verdicts.
  2. Split the linter comparison: move the README-presentation notes into add-peer-linter, drop the Future Plans tracking section, and strip inline plan references. Keep the pin-a-version advice.
  3. Clean the concepts pages (engine-api and flavor-rule-convention-kind): state shipped behavior without plan-tracking framing.
  4. Replace plan-number references in guides and reference pages with plain feature descriptions.
  5. Clean the flagged rule READMEs the same way (MDS020, MDS024, MDS047, MDS053 through MDS058).
  6. Apply remaining triage findings, regenerate catalogs with mdsmith fix, and leave mdsmith check . green.

Acceptance Criteria

  • No published page references a plan file, a plan number, or PLAN.md outside fenced example content.
  • Maintainer guidance found on published pages now lives under docs/development.
  • mdsmith check . passes.