docs: rewrite README for evidence-first positioning#19
Conversation
Shift from spec-heavy catalog to product narrative: what works today, Quick Start with fail-closed example, counterfactuals rationale, honest roadmap. Intent example uses canonical block grammar that passes the validator; demo link deferred to roadmap until published. Co-authored-by: Michael Judan <[email protected]>
|
Bugbot is not enabled for your account, so this pull request was not reviewed. Enable Bugbot in the Cursor dashboard to get automatic reviews on future PRs. |
There was a problem hiding this comment.
💡 Codex Review
Here are some automated review suggestions for this pull request.
Reviewed commit: 3c9e704694
ℹ️ About Codex in GitHub
Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you
- Open a pull request for review
- Mark a draft as ready
- Comment "@codex review".
If Codex has suggestions, it will comment; otherwise it will react with 👍.
Codex can also answer questions or update the PR. Try commenting "@codex address that feedback".
| To make the gate binding, mark **Intent Publication Gate** as a required | ||
| status check in branch protection. That is the moment EPICON becomes a | ||
| precondition gate rather than an audit log. | ||
| **3. The Guard validates.** A PR without a valid intent block fails closed: |
There was a problem hiding this comment.
Document the EP-1 fail-open path
When changed-file analysis succeeds and all changed paths classify as EP-1 (for example a docs-only PR touching README.md), validatePullRequest returns PASS_WITH_BACKFILL and shouldFailCheck exits 0 even with mode: enforce. This fail-closed statement teaches admins a stricter guarantee than the Action actually enforces, so users can configure branch protection expecting missing intent to block every PR when EP-1 changes still pass.
Useful? React with 👍 / 👎.
|
|
||
| The hosted attestation layer (Guard App, dashboard) is not covered by this | ||
| repository license — only the grammar and validator source here. | ||
| [AGPL-3.0](LICENSE) |
There was a problem hiding this comment.
Correct the README license claim
The README now advertises AGPL-3.0, but the linked LICENSE file is still CC0-1.0 and package.json also declares "license": "CC0-1.0". Consumers checking the README before reusing the Action will see conflicting license terms, so this should either keep the README on CC0 or update the actual license file and package metadata in the same change.
Useful? React with 👍 / 👎.
| cd epicon | ||
| node test/classify.test.mjs | ||
| npm install | ||
| npm test |
There was a problem hiding this comment.
Keep the Action-specific test command
npm test invokes turbo test, which only runs workspace package scripts and does not run the root Action tests such as node test/classify.test.mjs or node test/policy-ref.test.mjs. Since this replaces the explicit classifier test command, contributors can follow the README and believe they verified the shipped GitHub Action while the validator/policy tests were skipped.
Useful? React with 👍 / 👎.
Mobius PR — Cycle
1. Summary
Rewrites the README from a spec-heavy catalog into a product narrative: one honest "what works today" table, Quick Start with fail-closed error output, counterfactuals rationale, proposer-independence / deny-by-default design notes, and a tiered roadmap. Holds the README to the same standard the Guard holds PRs — no claim without evidence.
2. Details
DEMO_LINK_PLACEHOLDERreplaced with honest roadmap deferral — demo repo is listed under Roadmap → Next, not shipped.3. Tests
node test/classify.test.mjs— 11/11 passnpm test— 3 packages passIntent Publication
"We heal as we walk." — Mobius Substrate