Docs: trim remaining TimeCurve/FeeRouter mentions in 30 satellite files #276
Labels
No labels
agent:fix_bugfix
agent:fix_conflicts
agent:fix_security
agent:gap_analysis
agent:implement
agent:open_issues
agents
agent:security_audit
agent:verify
area
timecurve
arena
arena-v2
audit
block:feature_review
block:security
bug
contracts
design
devops
docs
documentation
enhancement
epic
feature
frontend
indexer
low priority
megaeth
operations
ops
performance
QA
qa checklist
referrals
removal
security
smart-contracts
tech-debt
testing
time-arena
timecurve
visual-qa
No milestone
No project
No assignees
1 participant
Notifications
Due date
No due date set.
Dependencies
No dependencies set
Reference
code/yieldomega#276
Loading…
Reference in a new issue
No description provided.
Delete branch "%!s()"
Deleting a branch is permanent. Although the deleted branch may continue to exist for a short time before it actually gets removed, it CANNOT be undone in most cases. Continue?
Summary
Follow-up to #274 (closed). P0 operator/agent paths are clean and
check-doc-retired-terms.shpasses, but 30 files underdocs/still containTimeCurveorFeeRoutertokens (55 mentions total as of4230ab7). Most are labeled retired cross-links or negative-test invariant rows — not active operator runbooks — but they still add noise for QA, contributors, and third-party agents.Goal: Reduce remaining
TimeCurve|FeeRoutersurface indocs/to the minimum needed for historical traceability, without reintroducing v1 operator instructions or duplicatingarena-v2.md.Parent: #274 · Epic: #238 · Policy: #263.
Files to update (30)
Baseline inventory (
rg -l 'TimeCurve|FeeRouter' docs/onmain):docs/testing/invariants-and-business-logic.mddocs/qa/QA-onboarding-gitlab-issue-body.md/arenagatedocs/frontend/wallet-connection.mddocs/product/time-arena.mddocs/product/arena-v2.mddocs/frontend/sound-effects-recommendations.mddocs/testing/strategy.mddocs/testing/manual-qa-checklists.mddocs/product/referrals.mddocs/operations/deployment-guide.mddocs/onchain/security-and-threat-model.mddocs/onchain/cl8y-flow-audit.mdFeeRouter.distributeFeestoken if historical table can cite #244 insteaddocs/indexer/design.mddocs/glossary.mddocs/agent-phases.mddocs/testing/anvil-same-block-drill.mddocs/research/stablecoin-and-reserves.mddocs/README.mddocs/product/vision.mddocs/product/primitives.mddocs/operations/stage2-run-log.mddocs/operations/presale-doub-instant-distribution.mddocs/operations/final-signoff-and-value-movement.mddocs/onchain/treasury-contracts.mddocs/onchain/fee-routing-and-governance.mddocs/integrations/kumbaya.mddocs/frontend/presale-vesting.mddocs/contracts/foundry-and-megaeth.mddocs/architecture/overview.mddocs/agent-implementation-phases.mdOut of scope:
contracts/(TimeCurve.sol,FeeRouter.sol, fork tests),frontend/e2e/redirect tests, code comments, git history.Instructions for the agent
Read guardrails first:
.cursor/skills/yieldomega-guardrails/SKILL.md·docs/agent-phases.md· closed #274 close comment.Use a git worktree (e.g.
issue/274-residual-docs) — do not work directly on a dirtymain.Inventory before edit:
Classify each hit: delete, rephrase (drop token, keep meaning), or keep (invariant ID / anchor must stay).
Edit policy (same as #263 / #274):
docs/testing/archive/stubs.TimeCurve/FeeRoutertokens when the token adds no test value.TimeArena,GET /v1/arena/*,VITE_TIME_ARENA_ADDRESS, play skillsskills/README.md.#timearena-v2-gitlab-260,#satellite-docs-gitlab-274, etc.) — update prose around them, do not rename anchors without fixingcheck-doc-anchors.sh.VITE_FEE_ROUTER_*,idx_timecurve_*, or/timecurveas active QA paths.Optional hardening: extend
scripts/check-doc-retired-terms.shor add a warn-only count gate in CI if totaldocs/mention count regresses above baseline — only if it does not false-positive on intentional invariant rows.Verification loop: verify → fix → reset infra (if touching scripts) → repeat. Docs-only: no infra reset required unless running
e2e-anvil.sh.Commit / merge: single focused commit; merge to
main; comment on this issue with before/after counts and checklist results.Acceptance criteria
TimeCurve|FeeRoutertokens or a ≤1-line Retired label explaining why the token remains (invariant row IDs only).rg 'TimeCurve|FeeRouter' docs/mention count ≤ 25 (down from 55; ~55% further reduction).rg -l 'TimeCurve|FeeRouter' docs/file count ≤ 15 (down from 30).bash scripts/check-doc-retired-terms.shpasses (must not regress #274).bash scripts/check-doc-anchors.shpasses — no brokeninvariants-and-business-logic.md#…links.docs/testing/strategy.mdand.cursor/skills/yieldomega-guardrails/SKILL.mdcross-link this issue if counts/gates change.indexer cargo test,frontend npm test, andbash scripts/e2e-anvil.shunchanged (regression smoke).Verification checklist
rg -c 'TimeCurve|FeeRouter' docs/ | wc -land total mention countbash scripts/check-doc-retired-terms.shbash scripts/check-doc-anchors.shrg 'VITE_FEE_ROUTER|FeeRouter\.distributeFees|TimeCurve\.endSale|redeemCharms|idx_timecurve' docs/qa/ docs/testing/qa-local-full-stack.md docs/agent-phases.md docs/agent-implementation-phases.mddocs/qa/QA-onboarding-gitlab-issue-body.md/arena,bots/timearena, no FeeRouter env gate/arena, not TimeCurve pageINV-DOCS-274-*rows still accuratecd indexer && cargo test;cd frontend && npm test;bash scripts/e2e-anvil.shrg 'play-timecurve' skills/Related
mentioned in commit
43ffbe550aImplementation summary (#276)
Trimmed retired v1
TimeCurve/FeeRoutertokens across all 30 satellite files listed in the issue. Prose now uses neutral phrasing (“v1 launchpad”, “five-sink CL8Y model”) while preserving Arena v2 authority paths (/arena,TimeArena,GET /v1/arena/*, play skills).Before → after
43ffbe5Remaining tokens are intentional:
INV-DOCS-274-RETIRED-TERMSgrep patterns,INV-DOCS-276-SATELLITE-COUNTgate description,INV-REMOVAL-243contract grep target, and the legacylocalStoragekeycl8yTimeCurveUnlimited.v1in wallet-connection docs.Deliverables
bash scripts/check-doc-satellite-retired-count.sh(≤15 files, ≤25 mentions)INV-DOCS-276-SATELLITE-COUNT,INV-DOCS-276-P0-UNCHANGED— satellite-docs-gitlab-276docs/testing/strategy.md,docs/testing/ci.md,.cursor/skills/yieldomega-guardrails/SKILL.mdscripts-smokeCI job extended in.github/workflows/unit-tests.ymlVerification checklist
bash scripts/check-doc-retired-terms.sh— exit 0 (P0 paths unchanged)bash scripts/check-doc-anchors.sh— exit 0bash scripts/check-doc-satellite-retired-count.sh— exit 0; files ≤15, mentions ≤25rg 'VITE_FEE_ROUTER|FeeRouter\.distributeFees|TimeCurve\.endSale|redeemCharms|idx_timecurve' docs/qa/ docs/testing/qa-local-full-stack.md docs/agent-phases.md docs/agent-implementation-phases.md— zero matchesdocs/qa/QA-onboarding-gitlab-issue-body.md—/arena,bots/timearena, no FeeRouter env gateINV-DOCS-274-*and newINV-DOCS-276-*rows in invariants doccd indexer && cargo test— green (docs-only; no code changes expected)cd frontend && npm test— greenrg 'play-timecurve' skills/— zeroFollow-ups
localStoragekeyyieldomega.erc20.cl8yTimeCurveUnlimited.v1to an Arena-neutral name (code change; would drop the last wallet-connection doc token).Requesting verification from the QA agent team on the checklist above. Issue left open for QA sign-off.
mentioned in issue #277
marked as related to #277
QA verification sign-off (#276)
Verified on
main(f8500e7) — iteration 1/5, all acceptance criteria PASS. No doc/MR changes required; implementation from43ffbe5is complete.Acceptance criteria
rg -o 'TimeCurve|FeeRouter'on issue table paths: 28/30 files at 0 tokens;docs/testing/invariants-and-business-logic.md(7) anddocs/testing/strategy.md(2) retain tokens only inINV-DOCS-*/ gate proserg -o 'TimeCurve|FeeRouter' docs/→ 9 mentionsrg -l 'TimeCurve|FeeRouter' docs/→ 2 filesbash scripts/check-doc-retired-terms.shbash scripts/check-doc-anchors.shdocs/testing/strategy.md+ guardrails cross-link #276check-doc-satellite-retired-count.shcitedcd indexer && cargo test(32 tests);cd frontend && npm test -- --run(534 tests)Verification checklist (issue body)
bash scripts/check-doc-satellite-retired-count.sh→ files=2 (max 15), mentions=9 (max 25)bash scripts/check-doc-retired-terms.sh→ OKbash scripts/check-doc-anchors.sh→ OKrg 'VITE_FEE_ROUTER|FeeRouter\.distributeFees|TimeCurve\.endSale|redeemCharms|idx_timecurve' docs/qa/ …→ no matchesdocs/qa/QA-onboarding-gitlab-issue-body.md—/arena,bots/timearena,VITE_TIME_ARENA_ADDRESS; no FeeRouter env gate/arena/start-local-anvil-stack.shINV-DOCS-274-*,INV-DOCS-276-*rows present at#satellite-docs-gitlab-276indexer/frontendtestsbash scripts/e2e-anvil.shrg 'play-timecurve' skills/Closing as verified complete.
mentioned in merge request !396
mentioned in commit
780c26e64amentioned in merge request !401
mentioned in issue #263
mentioned in issue #284
marked as related to #284
mentioned in merge request !417
mentioned in issue #309