docs(docs): sync initiative 0006 + 0010 status with actual code state#2997
Merged
Conversation
Audit found both initiatives significantly ahead of their doc status headers. 0006 (frontend routing): Phases 1–3 fully done, Phase 4 partial (PostHog route_change metric pending), Phase 5 partial (manualChunks + route-loaders pending). Checklist checkboxes and Outcome sections updated. 0010 (revenue-first): Phases 0–6 largely done (Google auth, billing backend, usePlan, A/B test, landing page); Apple auth, EN locale, sitemap, and PricingPage portal link still pending. New Outcome sections added. Regenerated open-work.md and today.md via pnpm docs:gen-*.
Contributor
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
📝 WalkthroughWalkthroughDocumentation infrastructure and initiative status synchronization: Prettier and freshness-tooling configuration prevent reformatting of auto-generated dashboards; initiative documents update validation dates and progress across routing (Phases 1–5 partial) and revenue initiatives (six phases with paywall and onboarding); dashboards reflect those status changes. ChangesDocumentation Freshness Tooling and Initiative Updates
Estimated code review effort🎯 2 (Simple) | ⏱️ ~12 minutes Possibly related PRs
Suggested labels
Poem
🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches📝 Generate docstrings
🧪 Generate unit tests (beta)
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
![cubic-dev-ai[bot]](https://avatars.githubusercontent.com/in/1082092?s=60&v=4){kind=small}
There was a problem hiding this comment.
1 issue found across 4 files
You’re at about 91% of the monthly reviewed-line limit. You may want to disable incremental reviews to conserve quota. Reviews will continue until that limit is exceeded. If you need help avoiding interruptions, please contact contact@cubic.dev.
Reply with feedback, questions, or to request a fix.
Re-trigger cubic
⏱️ CI Pipeline Duration ReportBased on the last 50 successful runs on the default branch. Overall Pipeline
Trend (last 20 runs): Per-Job Breakdown
|
…reshness gate .telemetry/ holds auto-generated analytics state (skill agent output) — not a governance doc, has no review cadence. mockups/ holds visual design artifacts (standalone HTML files) — not governance docs. redesign-v2/handoff-package/ and handoff.md are one-time handoff deliverables, not living documents requiring a freshness cycle. Fixes check-freshness CI failure on PRs triggered by the addition of these directories in recent main commits (#2944, #2951, #2957, #2961).
Phase 4.2 (PricingPage) is only partial: checkout flow is done but the Customer Portal link for Pro users is still pending. Use 4.2(partial) to be consistent with other partial phases in the status header.
Regenerates: open-work.md, today.md, initiatives/follow-ups.md, governance/hard-rules-matrix.md, governance/freshness-dashboard.html. All five were stale after the 0010 Phase 4.2 status correction (partial instead of done) and the freshness-config.json exclusion additions.
bump-last-validated.mjs was replacing the `by docs:gen-today` handle with the committer's handle (e.g. @Skords-01), making the committed version permanently diverge from what generate-today.mjs --check would regenerate in CI. Similarly, prettier was reformatting freshness-dashboard.html in ways the HTML generator didn't match. Fix: skip AUTO-GENERATED files in bumpFiles() by detecting the <!-- AUTO-GENERATED FILE comment marker. Add the four rollup docs to .prettierignore so prettier doesn't reformat them after generation (same pattern as openapi.json and pact files already there). Regenerates today.md and freshness-dashboard.html to the clean generator output so the commit matches what CI expects.
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 1
🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
Inline comments:
In `@scripts/docs/bump-last-validated.mjs`:
- Around line 202-207: The skip logic in the conditional that checks
content.includes("<!-- AUTO-GENERATED FILE") should be broadened to detect both
canonical markers so auto-generated docs using "<!-- AUTO-GENERATED -->" are
also skipped; update the conditional (the if that reads content.includes(...),
which logs `log(\` skip (auto-generated): ${rel}\`)` and continues) to check
for either marker or a single substring like "AUTO-GENERATED" so both variants
are matched and those files are not bumped.
🪄 Autofix (Beta)
Fix all unresolved CodeRabbit comments on this PR:
- Push a commit to this branch (recommended)
- Create a new PR with the fixes
ℹ️ Review info
⚙️ Run configuration
Configuration used: defaults
Review profile: CHILL
Plan: Pro Plus
Run ID: 2f94a654-d478-40ba-8d73-240951705438
📒 Files selected for processing (10)
.prettierignoredocs/governance/freshness-dashboard.htmldocs/governance/hard-rules-matrix.mddocs/initiatives/0006-frontend-routing-and-code-split.mddocs/initiatives/0010-revenue-first-launch.mddocs/initiatives/follow-ups.mddocs/open-work.mddocs/today.mdscripts/docs/bump-last-validated.mjsscripts/docs/freshness-config.json
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
Phase 2 next: fizruk + routine— updated toIn progress — Phases 1+2+3+4(partial)+5(partial) done. All 4PATH_BASED_MODULE_IDSmodules already path-based; HashRedirect shim, per-route bundle budgets, and ESLint error level all done. Pending: PostHogroute_changemetric (Phase 4),manualChunkscleanup + route-loaders (Phase 5).Phase 5.1 done — Phase 2 next— updated toIn progress — Phases 0+1+2+3+4.1+4.2(partial)+4.3(Google)+5.1+5.2+6(partial) done. Billing backend,usePlan, PaywallModal, Google auth, A/B test (GoalFirstScreen), and LandingPage all done. Pending: Apple auth, EN locale, sitemap/robots.txt, PricingPage portal link (4.2 partial)..telemetry/**andmockups/**toexcludeGlobsinfreshness-config.json; added 3 redesign-v2 handoff files toexplicitExclude. These were added in recent main commits without freshness headers, causing CI failures on all PRs.open-work.md,today.md,follow-ups.md,hard-rules-matrix.md,freshness-dashboard.html.size/override rationale
2430 counted lines, but only ~145 are human-authored (2 initiative docs + freshness-config.json). The rest is from 4 auto-generated files that the docs:gen-* scripts must regenerate whenever a Status header changes:
docs/governance/freshness-dashboard.html— full HTML dashboard (~1200 lines), regenerated bypnpm docs:freshness-dashboarddocs/open-work.md— rollup of all 98 open docs, regenerated bypnpm docs:gen-open-workdocs/today.md— daily brief, regenerated bypnpm docs:gen-todaydocs/initiatives/follow-ups.md— follow-ups rollup, regenerated bypnpm docs:gen-initiative-followupsThese files should be in the size check's IGNORE_GLOB (like
hard-rules-matrix.mdalready is); this override is a stopgap until that CI fix lands.Governing Skill
sergeant-docs(docs governance + freshness system)Playbook
Verification
Additional checks:
Docs and Governance
AGENTS.mdneeded an update. (no — doc-only change)Updated docs:
docs/initiatives/0006-frontend-routing-and-code-split.md— status + checklist + Outcome sectionsdocs/initiatives/0010-revenue-first-launch.md— status + checklist + Outcome sectionsscripts/docs/freshness-config.json— exclusions for .telemetry + mockups + handoff filesdocs/open-work.md,docs/today.md,docs/initiatives/follow-ups.md,docs/governance/hard-rules-matrix.md,docs/governance/freshness-dashboard.html— regeneratedRisk and Rollout
pnpm docs:gen-*runHard Rule #15
AGENTS.mdbefore coding.--no-verify.Audit-freeze (until 2026-06-02)
Reviewer Notes
Doc-only PR. No migrations, no env changes, no auth changes. The freshness-config.json change makes CI green for all future PRs that don't touch .telemetry/ or mockups/ — those directories were landing without freshness headers in recent commits (#2944, #2951, #2957, #2961).
The
size/overridelabel is applied because the XXL size is entirely from auto-generated documentation files, not human-authored code.🤖 Generated with Claude Code
Summary by CodeRabbit
Documentation
Chores