docs(readme): restore compliant stamp deleted by PR #8 - #22
Merged
Conversation
…ut, quick start) PR #8 (318990c, 2026-05-16) rewrote the README around the risk-first philosophy and, in doing so, silently deleted the badge row, the `[!NOTE]` status callout, and the blockquote tagline that the 2026-05-03 readme-system stamp had produced (see 721facf). No later pass (including the #20 accuracy-only fix) restored them, so the opted-in repo drifted out of compliance with its own required section order even though every claim in the prose stayed true. Restored, verbatim where prior wording existed in history: - Blockquote tagline (from 721facf, the last correct `active`-status stamp) - Badge row: CI (native workflow badge), License, Status (active/brightgreen) - `[!NOTE]` active-project callout, canonical phrasing - `## Quick start`: clone/cd + `pip install pytest && pytest` as the runnable-today path (this repo requires a QuantConnect project to run the algorithm itself; pytest is the only thing a visitor can run without external setup) - Section order per spec: tagline, badges, callout, quick start, what it does, domain sections, usage, license - Added one factual line reinforcing existing canon: strategy.yaml is pinned at `stage: local` (verified against the file), so nothing here implies a promoted paper or live strategy The `## What it does` body text is carried over unchanged (relocated, not reworded) pending a separate competitive-wording pass; that atom is staged at .dotfiles/.artifacts/pfd-mission/tournament-atoms-tradingbot.json. Topics: added `wranngle` + `active-project` via `gh repo edit --add-topic` (additive only, existing domain topics untouched). Verified: 126 pytest tests pass unchanged (python3 -m pytest -q). Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
github-actions
Bot
added
the
pr-needs-issue
|
This PR needs an issue link. Add |
This was referenced Jul 11, 2026
docs: bring README to wranngle flagship standard (wordmark, live gauntlet demo, punchline table)
#23
Closed
github-actions Bot
pushed a commit
that referenced
this pull request
Jul 11, 2026
…unchline table (#24) ## Summary - Centered header block: light/dark wordmark (generated from the repo's own badge hex `A371F7`, generator committed at `docs/brand/render.mjs`), capability eyebrow, value-prop H1, pipe nav, real badges (CI, License, static stage-local). - Real hero GIF: `demo_gauntlet.py unsafe` raising `RiskGauntletError: leverage_cap violated (actual=3.0, allowed<=2.0)` then `demo_gauntlet.py safe` accepting the default config. Driven against the real `Config` + `RiskGauntlet` classes via the committed `tests/conftest.py` stub, no mocks. VHS tape and measurements committed under `docs/media/`. - Emoji feature bullets, 5-node mermaid flow, reject/accept punchline table, lifecycle stage table, lab bench section for the standalone tools, honest roadmap (pytest-in-CI gap, duplicate cap table). - Builds on the stamp restored by #22 (merged); replaces the `[!NOTE]` callout per flagship style. ## Test plan - `python3 -m pytest -q` in the branch worktree: `126 passed`. - `python3 demo_gauntlet.py unsafe` exits 1 with the rejection line; `python3 demo_gauntlet.py safe` exits 0. - Mermaid block validated via mermaid.ink (HTTP 200, rendered image). - No em/en-dashes, no banned vocabulary, all nav anchors present. Closes #23 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-authored-by: Claude Fable 5 <noreply@anthropic.com>
wranngle
removed
the
pr-needs-issue
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
[!NOTE]status callout, and blockquote tagline that the 2026-05-03 readme-system stamp had produced. Neither docs(readme): rewrite around risk-first philosophy #8 nor the later docs: accurate README #20 accuracy fix restored them.## Quick start(new, not previously present):git clone+cd+pip install pytest && pytest, since this is the only runnable-today path without an external QuantConnect account.strategy.yamlis pinned atstage: local(verified against the file in this repo), so nothing here implies a promoted paper or live strategy. Backtest-only, never ran live.## What it doesprose is carried over unchanged (relocated, not reworded); a competitive-wording pass for that section is staged separately, not part of this PR.wranngle+active-projectviagh repo edit --add-topic(additive only, already applied directly since topics are not part of the branch-protected file surface).Test plan
python3 -m pytest -q— 126 passed, unchangedgrep -cP '[—–]' README.md→ 0docs/exec-plans/active/WRANNGLE-README-SYSTEM.md§3/§4/§9 for verbatim callout/badge/order complianceCo-Authored-By: Claude Fable 5 noreply@anthropic.com