docs: add ECOSYSTEM.md and the README process-flow section - #4
Open
Chheng64 wants to merge 3 commits into
Open
Conversation
Compatibility stated structurally — open artifacts and exit codes — with planned connectors quarantined in their own section, each row linking its roadmap phase. Named for compatibility, not connectors: the toolkit ships none, and that is the point. Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
Insert a Process flow section between What you'll build and Build your first project: a mermaid overview (brief -> workflow -> artifacts -> validators + human gates -> handoff -> package), a four-line summary in existing repo language, a prompt-based-AI comparison row, and the twelve states in machine order with the three human gates marked. Links to WORKFLOW_GUIDE.md and ARCHITECTURE.md for the detail. Verified with tools/mermaidcheck.mjs (35 blocks, 0 blocking) and tools/linkcheck.mjs (954/954 internal links resolve). Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
The section landed in 4081c24 without a changelog entry. Recorded under Changed, next to the landing-page rewrite it extends: what the section holds, that it summarizes rather than replaces WORKFLOW_GUIDE.md and ARCHITECTURE.md, and why STATE 12 is shown before 11. Verified with tools/linkcheck.mjs (954/954 internal links resolve) and tools/mermaidcheck.mjs (35 blocks, 0 findings). Co-Authored-By: Claude Opus 5 (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
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.
What
Two documentation additions on the same theme — telling a reader what the toolkit is and what it fits with, without moving detail out of the documents that already hold it.
ECOSYSTEM.md— what "works with your existing workflow" means, stated structurally rather than as a partner list. Plus a README docs-table row and a CHANGELOG entry.README.md— the whole run in one picture, between "What you'll build" and "Build your first project".Why this shape
ECOSYSTEM.mdFAQ.md,VALIDATION_ENGINE.md,ARTIFACT_FLOW.md,DIFFERENTIATORS.md,checks.yml).dtkCLI, the shared artifact store, the Phase 5 packs — each row linking itsPUBLIC_ROADMAP.mdphase, so the line between "works today" and "planned" stays visible.ECOSYSTEM.mdrather thanINTEGRATIONS.md: the page is about compatibility, not built-in connectors. The toolkit ships none; that is the point, not a gap.README process flow
WORKFLOW_GUIDE.mdandARCHITECTURE.mdkeep the detail. Same division the landing-page rewrite established in docs: rewrite README as landing page, extract FAQ #3.STATE 10 · Revisionis shown as the loop rather than a step, andSTATE 12before11, because that is the machine order — a reader meeting the states for the first time should meet them true.Validation
node tools/linkcheck.mjs— 954/954 internal links resolve, 0 findings, exit 0node tools/mermaidcheck.mjs— 35 blocks across 89 files, 0 findings, exit 0🤖 Generated with Claude Code