docs(readme): lead with trading, keep the watchdog case underneath - #11
Merged
Conversation
Restructures the README hero without changing a line of code, and folds in the
watchdog/compliance material that had been sitting uncommitted in the working
tree since the earlier positioning pass.
Hero:
- Opens with who it is for and what they get rather than three abstract nouns.
"A deterministic DSL for replayable, host-governed decision rules" becomes
"Trading and agent rules that run the same way every time — with a receipt."
- Puts a real, recognisable rule above the fold: the MaxDrawdownBreaker from
nano/library/risk, comment header trimmed. It emits PAUSE and escalates to a
named agent, so it shows the host-governance separation directly and carries
no directional or performance implication.
- Adds a short "why that matters when money is on the line" list covering
determinism, auditability, host governance, and size.
- DSL / IR / host-governed all stay, in the body, for readers who want them.
Structure:
- "Start with the strategy library" moves up to sit directly after "Quick
start" — it is the section that makes the product concrete and it was
fourth.
- The watchdog, compliance, audit-evidence and explainable-automation sections
land after "Small by design", so trading leads and the general case follows
in the same document.
Every fenced `nano` block in the file is compiled by tests/test_docs.py, and the
three in this change (MaxDrawdownBreaker, TrustedRouteWatchdog,
ReleaseCompliance) were each verified against the compiler before landing. The
marked README-EXAMPLE block is untouched.
No performance, return, or win-rate claims anywhere. 378 passed, 2 skipped.
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.
README-only. No code changes.
Two things at once: the hero rewrite from the distribution push, and the watchdog/compliance material that had been sitting uncommitted in the working tree since the earlier positioning pass. Rather than discard either, trading leads and the general case follows in the same document.
Hero
The old line is accurate and names nobody with a problem. It also opens with three abstract nouns, which is roughly two seconds of a topic-page visitor's attention spent on vocabulary.
A real rule now sits above the fold — the
MaxDrawdownBreakerfromnano/library/risk/, comment header trimmed:Chosen deliberately over an entry signal: it emits
PAUSEand escalates to a named agent, so it demonstrates the host-governance separation directly and carries no directional or performance implication.DSL,IRandhost-governedall stay — in the body, where readers who want that vocabulary will find them. They just aren't the front door.Structure
Start with the strategy librarymoves up, to sit directly afterQuick start. It is the section that makes the product concrete, and it was fourth.Small by design— trading first, general case underneath.Every other section is unchanged and still present.
Verification
tests/test_docs.pycompiles every fencednanoblock in the repo's markdown, so a README example that doesn't compile fails CI. All three blocks introduced or moved here were checked against the compiler before landing:MaxDrawdownBreakerPAUSETrustedRouteWatchdogPAUSE,OBSERVEReleaseCompliancePAUSE,OBSERVEThe marked
<!-- README-EXAMPLE -->block guarded bytests/test_readme_example.pyis untouched.Full suite: 378 passed, 2 skipped.
Claims check
No performance, return, win-rate, or backtested figures anywhere. The framing that Nano proposes an Intent and the host decides whether to act is kept prominent — it's true, and it's what keeps the project clear of anything resembling investment advice. The strategy library keeps its "conformance corpus, not a performance claim" disclaimer.