docs: refresh README + mark M10 shipped (review pass) - #121
Merged
Conversation
- README: simpler, current — leads with the shared-services idea + quickstart, documents the interactive-DX surface (use/context/shell-init, project/env authoring, framework+monorepo templates with hot reload, `devstack run`, top-level expose/ports), a compact command overview, and links the guide. - ROADMAP/FEATURES: M10 "Interactive-DX lane" marked SHIPPED (specs 30/31, D18/D19) instead of proposed. Doc review verdict: all docs kept. Only stale markers were the M10 "proposed" tags (fixed here) and the guide "not shipped" sections (fixed with the feature PRs). ARCHITECTURE §6 module map may later add the M10 packages (internal/task, internal/branding, active-context) — additive, non-blocking. Co-Authored-By: Claude Opus 4.8 (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.
Summary
Finishes the two remaining doc tasks. Stacked on #120 so the diff is docs-only (base retargets to
mainonce #120 merges).1. README rewrite (simpler + current)
Rewrote
README.md(259 → ~210 lines): leads with the shared-services idea and a copy-paste quickstart, then a tight What you get covering the whole shipped surface — active context (use/context), shell integration (shell-init), project/env authoring, framework + monorepo templates with hot reload, thedevstack runtask graph, top-levelexpose/ports, the data plane, secrets/networking — a compact command overview grouped by area, and a link to the guide.2. Doc review (keep / prune / update)
Reviewed every file under
docs/:Only stale content found was the M10 "proposed" markers (fixed) and the guide "not shipped" sections (fixed with the feature PRs). Nothing warrants pruning. Noted for later: ARCHITECTURE §6's module map could list the M10 packages (
internal/task,internal/branding, active-context) — additive, non-blocking.🤖 Generated with Claude Code