docs: rewrite README as a project overview#103
Closed
d3v07 wants to merge 2 commits into
Closed
Conversation
Lead with the core safety rule, document the shipped multipage dashboard + routes, the API contract, golden path, verification criteria, quick start, and live demo. Corrects stale approval-gate wording to shipped behavior. Docs-only; no secrets.
Owner
Author
|
Closing unmerged — superseded by the two-persona real-workload direction; docs will be refreshed to match the new flow. |
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.
Rewrites the root
README.mdinto a proper project overview: leads with the safety rule (agents recommend / deterministic code decides / humans approve / verification proves), documents the shipped multipage dashboard + routes, the API contract, the golden path, verification criteria, quick start, and the live demo. Corrects the stale 'opens approval gate before diagnosis' wording to the shipped 'gated read-only run' phrasing.Overlap note: PR #101 also edits
README.md(a small wording fix that this rewrite already incorporates). The two overlap only onREADME.md— recommend merging this rewrite and droppingREADME.mdfrom #101 (its other 6 files are unaffected), or resolving the trivial overlap in favor of this rewrite at merge.Docs-only; no code, no secrets, no skills.