Skip to content

docs: add ECOSYSTEM.md and the README process-flow section - #4

Open
Chheng64 wants to merge 3 commits into
mainfrom
docs/ecosystem-page
Open

docs: add ECOSYSTEM.md and the README process-flow section#4
Chheng64 wants to merge 3 commits into
mainfrom
docs/ecosystem-page

Conversation

@Chheng64

@Chheng64 Chheng64 commented Aug 7, 2026

Copy link
Copy Markdown
Owner

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.
  • A Process flow section in README.md — the whole run in one picture, between "What you'll build" and "Build your first project".

Why this shape

ECOSYSTEM.md

  • Every artifact is markdown, HTML, JSON or CSV on disk; every check is a zero-dependency Node script with an exit code. Anything that reads a file or runs a command can participate — that claim carries the page, and each category backs itself with an existing document (FAQ.md, VALIDATION_ENGINE.md, ARTIFACT_FLOW.md, DIFFERENTIATORS.md, checks.yml).
  • A Future connectors section quarantines the planned items — the dtk CLI, the shared artifact store, the Phase 5 packs — each row linking its PUBLIC_ROADMAP.md phase, so the line between "works today" and "planned" stays visible.
  • Named ECOSYSTEM.md rather than INTEGRATIONS.md: the page is about compatibility, not built-in connectors. The toolkit ships none; that is the point, not a gap.

README process flow

  • One Mermaid overview — brief → workflow → artifacts → validators and human gates → handoff → package — then the four claims that carry it, in existing repo language, a one-row comparison against prompt-based AI, and the twelve states in machine order with the three human gates marked.
  • It summarizes and links; WORKFLOW_GUIDE.md and ARCHITECTURE.md keep the detail. Same division the landing-page rewrite established in docs: rewrite README as landing page, extract FAQ #3.
  • STATE 10 · Revision is shown as the loop rather than a step, and STATE 12 before 11, 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 0
  • node tools/mermaidcheck.mjs — 35 blocks across 89 files, 0 findings, exit 0

🤖 Generated with Claude Code

Chheng64 and others added 3 commits August 7, 2026 20:56
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>
@Chheng64 Chheng64 changed the title docs: add ECOSYSTEM.md, the works-with page docs: add ECOSYSTEM.md and the README process-flow section Aug 17, 2026
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