docs: restructure docs, fix install story, add complete usage guide#11
Merged
Merged
Conversation
Redesign the documentation and install story around the cognitive-substrate paper, applying a ponytail (YAGNI / reuse-first / shortest-diff) discipline — no source rewrites, only what the docs actually needed. Install (the main ask — stop leading with `bash install.sh`): - Recommended paths are now the plugin (Claude Code / Codex) and a token-free CLI install `npm install -g github:CodeWithJuber/forgekit` (verified: installs in seconds, no clone, no GitHub Packages token). `bash install.sh` is demoted to the symlink/dev path; the GitHub Packages route is marked CI-only. - Applied across README, ONBOARDING, docs/cognitive-substrate/README, and the landing page (install snippet + stale version 0.2.0 -> 0.3.1). Docs: - README rewritten to a professional standard: value prop, install matrix, quickstart, three-layer "how it works" table, auto-use section, command list, honest limits, docs index. Dropped the broken public-npm version badge. - New docs/GUIDE.md: every command with a worked example and its REAL output (captured from a live run), the everyday workflow, auto-use inside an agent, recipes, and how to extend each layer. - CHANGELOG updated. Verified: 147/147 tests pass; the substrate auto-use wiring is genuine end to end (Claude hooks + the forge-cortex MCP server exposing substrate_check / predict_impact / assumption_gate / route_task / scope_files + the emitted rule). Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01Eh3SNx15EeVbTmU4nH36XC
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 & why
Redesigns the documentation and install story around the cognitive-substrate paper, applying a ponytail discipline (YAGNI / reuse-first / shortest-diff) — docs and config only, no source rewrites, no speculatively-built "gaps." The working, tested runtime is untouched.
The main ask: stop leading with
bash install.sh.npm install -g github:CodeWithJuber/forgekit— verified to install in seconds with no clone and no GitHub Packages token.bash install.shis demoted to the symlink/dev path; the GitHub Packages route is marked CI-only. Applied consistently across README, ONBOARDING,docs/cognitive-substrate/README.md, and the landing page (install snippet + stale version0.2.0→0.3.1).Documentation, professionalized:
docs/GUIDE.md— the complete guide the issue asked for: every command with a worked example and its real output (captured from a live run), the everyday workflow, auto-use inside an agent (Claude hooks + MCP + emitted rule), recipes, and how to extend each layer (rules, tools, guards, crew, routing signals, emitters, rebrand).CHANGELOG.mdupdated under## [Unreleased].Auto-use verified, not asserted: the substrate genuinely runs itself end to end — Claude Code hooks (
hooks/hooks.json) plus theforge-cortexMCP server exposingsubstrate_check/predict_impact/assumption_gate/route_task/scope_files, plus the "run substrate before risky work" rule thatforge initemits into every tool. Docs match the code.Checklist
npm testpasses (147/147, Node 22 locally; matrix runs 18/20/22 in CI)npm run checkpasses (Biome scopes tosrc/**+test/**; this PR touches neither)docs:)CHANGELOG.mdupdated under## [Unreleased]forge substrate/ MCP behavior changed)Risk & rollback
Extra checks (tick if applicable)
npm run typecheck— unaffected (no JS/TS changed)🤖 Generated with Claude Code
https://claude.ai/code/session_01Eh3SNx15EeVbTmU4nH36XC
Generated by Claude Code