Skip to content

Simplify documentation to ADR, Design Doc, and Roadmap#223

Merged
Skymly merged 1 commit into
mainfrom
docs/simplify-documentation-system
Jul 11, 2026
Merged

Simplify documentation to ADR, Design Doc, and Roadmap#223
Skymly merged 1 commit into
mainfrom
docs/simplify-documentation-system

Conversation

@Skymly

@Skymly Skymly commented Jul 11, 2026

Copy link
Copy Markdown
Owner

Summary

  • Simplify the in-repo documentation system to ADR + Design Doc + Roadmap, with task tracking and review on GitHub Issues / PRs / Releases.
  • Merge Spec API / diagnostic / invariant content into the seven Design Docs; delete docs/rfc/, docs/spec/, docs/plans/, and docs/review/.
  • Update DOCUMENTATION.md, AGENTS.md, CONTRIBUTING.md, PR template, README indexes, ADR metadata (link hygiene), ROADMAP, and CHANGELOG.

Test plan

  • rg "docs/(spec|rfc|plans|review)/" returns no remaining path references
  • Final docs/ tree contains only adr/, design/, and top-level maintainer docs
  • CI build-test / pack / samples green (docs-only change)

Remove in-repo RFC, Spec, Plan, and Review document types.
Merge Spec API/diagnostic/invariant content into Design Docs,
point task tracking and review at GitHub Issues and PRs, and
update AGENTS, CONTRIBUTING, PR template, ADR metadata, and
indexes so agents and humans follow the lighter conventions.
@Skymly Skymly merged commit 322fff4 into main Jul 11, 2026
3 checks passed
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