docs(readme): the context engine, a runnable 60-second quickstart, and a CLI reference (#66)#83
Merged
Merged
Conversation
…d a CLI reference (#66) The README explained the philosophy (grammar, moat, grounding) but a newcomer could not run anything: the only commands shown were the installer's. For an open-source GTM, time-to-first-deck is the adoption metric. - New 'The context engine' section: context is compiled, not prompted — the four typed stations (inputs ledger -> manifest -> versioned IR -> gates) with the gate that validates each hop, linked from 'How it works'. - 'Sourced vs assumed, visibly': the reference manifest's assumed cell side by side with the actual rendered line (**Churn logo Q3**: ⟨~4.2% — da verificare⟩) — the product's 5-second pitch. - 'Try it in 60 seconds': render -> lint -> emit_md -> facilitate prep, copy-paste-run — verified verbatim from a fresh clone on Windows (plus the optional pptx hop). Dependency-free path stated. - New .eamos-core/docs/cli.md: one page for every tool's ops and flags (render --ir/--altitude/--function/--redact, intake, series close|open, facilitate prep|followup, advisor record|match|simulate, the five emitters, check_docs), previously only in docstrings. - Status section refreshed: feature-complete through M8, not 'M2 in progress'. The #65 doc-path gate caught a pseudo-path in the first draft of the new section — fixed; check_docs green, 97/97 tests green. Closes #66 Co-Authored-By: Claude Fable 5 <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.
Problem (#66)
The README explained the philosophy well (grammar, moat, grounding) but a newcomer could not run anything: the only commands shown were the installer's. No quickstart, no explanation of how context flows through the machine, no CLI reference. For an open-source GTM, time-to-first-deck is the adoption metric.
What's added
ir_version, theme tokens, Windows CI leg).assumedcell side by side with the actual rendered line (**Churn logo Q3**: ⟨~4.2% — da verificare⟩): the product's best 5-second pitch.render→eamos_lint→emit_md→facilitate prep, verified verbatim from a fresh clone on Windows (plus the optional.pptxhop with python-pptx installed). Dependency-free path stated..eamos-core/docs/cli.md— one page for every tool's ops and flags:render --ir/--altitude/--function/--redact,intake --csv/--series/--deck/--questions,series close|open,facilitate prep|followup,advisor record|match|simulate, the five emitters,check_docs. Previously this knowledge lived only in docstrings.Verification
emit_pptx/docx/md/svg/xlsx) in the first draft of the new section — the guard already earns its keep.check_docsgreen; 97/97 tests green.Closes #66
🤖 Generated with Claude Code