docs: name skills + MCP as the canonical product path - #410
Open
mlieberman85 wants to merge 1 commit into
Open
Conversation
…evorg#356) A new user opens `darnit --help` and sees `audit`, `run`, `serve`, `harness`, `install` at the same visual weight. Nothing tells them which is the front door. The intended product path -- skills invoking darnit's MCP tools inside a coding-agent client -- lives in maintainer heads and RFC-0001 today, not in a place a user would find it. Adds a "How to Use Darnit" section to README.md between Installation and Quick Start: 1. Product path: install the MCP config + skills into Claude Code / Claude Desktop / Cursor via `darnit install`, then invoke a skill (e.g. `/darnit-audit`) in the agent. The skill orchestrates the MCP tools; the user reasons conversationally. 2. CLI as dev/test scaffolding: a per-command table names what each of `serve`, `audit`, `run`, `harness` is for and what it is NOT for. Only `serve` is product-facing (the MCP server behind the skills). `audit`/`run`/`harness` are development, CI, and driver- testing tools respectively. 3. Direction of travel: cross-links RFC-0001, which formalizes the split (CLI becomes thin adapters around the harness runtime, not parallel entry points). Also re-frames the existing Quick Start intro: the Python code snippets shown are MCP tool signatures the `/darnit-audit` skill calls under the hood; in normal use the reader invokes the skill and never sees them directly. Preserves the snippets for the "embed darnit in your own tooling" and "debug the skill's orchestration" cases. `docs/getting-started/README.md` already has an "I want to use darnit with Claude Code" path -- unchanged; that section is consistent with the new README framing.
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
Closes #356. Adds a "How to Use Darnit" section to
README.mdbetween Installation and Quick Start that names skills-via-MCP as the product path and frames the CLI (audit,run,harness) as development scaffolding rather than parallel entry points.Why
A new user opens
darnit --helpand sees five top-level commands at the same visual weight. Nothing tells them which is the front door. The intended product path -- install darnit's MCP config + skills into a coding-agent client, then invoke/darnit-auditin Claude Code -- lives in maintainer heads and RFC-0001 today, not anywhere a user would find it. They pickauditorrunand never touchserve, which is the actual product path (invoked automatically by the client).What landed
New
## How to Use Darnitsection with three subsections:darnit installvariants, restart the client, invoke a slash command, links todocs/getting-started/using-skills.md.serve,audit,run,harnessis for and, more importantly, what it is NOT for. Onlyserveis product-facing.docs/rfcs/0001-core-rearchitecture.md, which formalizes the split (CLI as thin adapters around the harness runtime, not parallel entry points).Also re-frames the existing Quick Start intro: the Python-signature examples in that section are MCP tool signatures the
/darnit-auditskill calls under the hood; in normal use the reader invokes the skill and never sees them directly. Preserves the snippets for the "embed darnit in your own tooling" and "debug what the skill orchestrates" cases.docs/getting-started/README.mdalready has an "I want to use darnit with Claude Code" path that's consistent with the new README framing -- unchanged.Not in scope
darnit --helpoutput. If we want the help text itself to signal the split (e.g. sortinstallandserveaboveaudit/run/harness, or mark the latter as "(dev/test)"), that's a separate change.Closes #356.