Skip to content

docs: rebuild DebateLab documentation - #39

Merged
Programcode merged 5 commits into
mainfrom
super-cauliflower
Sep 6, 2026
Merged

Programcode merged 5 commits into
mainfrom
super-cauliflower

Conversation

@Programcode

Copy link
Copy Markdown
Owner

Summary

  • replace the stale monolithic docs with a progressive-disclosure map for people and agents
  • document architecture, development, testing, operations, and Supabase ownership
  • add a dependency-free docs drift checker with tests and CI integration
  • reconcile active plans and label historical SEO and security records

Verification

  • npm run verify
    • docs check, lint, typecheck, coverage, Edge tests, and production build passed
    • Playwright desktop and mobile Chromium: 124 passed
  • docs checker tests: 29 passed
  • git diff --check

Scope

  • no database migrations, Edge Function changes, secrets, or production mutations
  • host storage cleanup was local-only and is not part of this diff

Programcode and others added 3 commits September 1, 2026 17:21
Rewrite eleven plans to cover only missing work, trim the bug backlog to
four reproducible items, add the PR #11 salvage plan, and delete completed
and obsolete plans.

Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>
Delete five plans whose implementations shipped and were verified against
origin/main at 79b65ca: admin announcements (#19, #26), agent verification
loop (#21, #26, #27), analytics and error tracking (#16, #18, #22-#25, #28),
animation polish (#20), and search quality (#17).

Trim the Supabase staging plan to the admin environment switcher, the only
unshipped code in it. Refresh snapshot headers on the remaining plans after
confirming PRs #16-#28 did not touch their scope, and re-verify all four
bug backlog items and their line references.

Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>
@vercel

vercel Bot commented Sep 6, 2026 •

Copy link
Copy Markdown

The latest updates on your projects. Learn more about Vercel for GitHub.

Project Deployment Actions Updated
debate-navigator Ready Ready Preview Sep 6, 2026 6:19pm UTC

@coderabbitai

coderabbitai Bot commented Sep 6, 2026 •

Copy link
Copy Markdown

Warning

Review limit reached

Next included review available in 41 minutes.

Check out review usage here.

View limit details

Limit details: You’ve used the included review currently available.

Enable usage-based reviews in Billing to review now. Otherwise, wait until the next included review is available.
You're only billed for reviews past your plan's rate limits ($0.25/file).

Learn how review limits work.

Review configuration:

⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Free

Run ID: c7690e15-5c24-413f-8983-9f54a83fc98f

📥 Commits

Reviewing files that changed from the base of the PR and between c7d3437 and fd0a61e.

📒 Files selected for processing (27)
  • .github/workflows/deploy.yml
  • .gitignore
  • .superset/db-gate.sh
  • AGENTS.md
  • README.md
  • docs/README.md
  • docs/architecture.md
  • docs/decisions/001-agent-friendly-documentation.md
  • docs/development.md
  • docs/operations.md
  • docs/seo-authority-opportunities-2026-07-05.md
  • docs/seo-debatelab-2026-07-05.md
  • docs/seo-escalation-2026-07-05.md
  • docs/superpowers/plans/2026-09-06-documentation-system.md
  • docs/superpowers/specs/2026-09-06-documentation-system-design.md
  • docs/testing.md
  • package.json
  • plans/README.md
  • plans/bugs.md
  • plans/control-honesty.md
  • plans/done/bugs.txt
  • plans/supabase-staging.md
  • scripts/check-docs.mjs
  • security/scans/2026-08-19-codex-security-06d93a47/README.md
  • src/test/docs/check-docs.test.ts
  • src/test/scripts/db-gate.test.ts
  • supabase/README.md

Note

🎁 Summarized by CodeRabbit Free

Your organization is on the Free plan. CodeRabbit will generate a high-level summary and a walkthrough for each pull request. For a comprehensive line-by-line review, please upgrade your subscription to CodeRabbit Essentials by visiting https://app.coderabbit.ai/settings/billing.

Comment @coderabbitai help to get the list of available commands.

# Conflicts:
#	AGENTS.md
#	plans/README.md
#	plans/control-honesty.md
#	plans/done/bugs.txt
#	plans/supabase-staging.md
@Programcode
Programcode merged commit fe679fd into main Sep 6, 2026
7 checks passed
@Programcode
Programcode deleted the super-cauliflower branch September 6, 2026 18:34
Programcode added a commit that referenced this pull request Sep 6, 2026
… globs

Dependencies with zero imports anywhere in src, e2e, scripts, supabase, or
any config file:

- @stripe/stripe-js: checkout and portal go through the create-checkout and
  create-portal Edge Functions and a plain URL redirect (src/lib/stripe.ts).
  The browser SDK is never loaded.
- i18next-browser-languagedetector: src/i18n.ts sets lng and fallbackLng
  explicitly and SettingsPage calls changeLanguage. No detector is registered.
- @types/jspdf and @types/react-joyride: both runtime packages ship their own
  declarations, so the DefinitelyTyped stubs are redundant.
- baseline-browser-mapping and caniuse-lite: incidentally added as direct
  dependencies, never imported. Both stay installed transitively through
  autoprefixer/browserslist, which is the only consumer. npm now records them
  as dev-only, since browserslist is a devDependency; that is safe here because
  every install path in this repo (Dockerfile, all three workflow jobs, Vercel)
  runs a plain `npm ci` with devDependencies included. No path uses
  --omit=dev or --production.

@types/file-saver stays: file-saver ships no declarations of its own.

Also removes two npm scripts and three dead Tailwind content globs:

- test:coverage, superseded by `npm test -- --coverage`. No workflow, script,
  or docs file invokes it. Two rows in .audit/crossfire.tsv do mention it, but
  those are historical records of August runs, not callers, and that log is
  deliberately left untouched.
- test:e2e:ui, which nothing references at all.
- the ./pages, ./components, and ./app content globs, for directories that do
  not exist in this repo.

The verify script keeps the docs:check step main added in #39.

Verified on main fe679fd, from a clean npm ci: docs:check, lint, typecheck,
956 unit tests, 121 edge tests, build, and 126 Chromium e2e tests pass.
Coverage 90.45% statements.
Programcode added a commit that referenced this pull request Sep 7, 2026
… globs (#35)

Dependencies with zero imports anywhere in src, e2e, scripts, supabase, or
any config file:

- @stripe/stripe-js: checkout and portal go through the create-checkout and
  create-portal Edge Functions and a plain URL redirect (src/lib/stripe.ts).
  The browser SDK is never loaded.
- i18next-browser-languagedetector: src/i18n.ts sets lng and fallbackLng
  explicitly and SettingsPage calls changeLanguage. No detector is registered.
- @types/jspdf and @types/react-joyride: both runtime packages ship their own
  declarations, so the DefinitelyTyped stubs are redundant.
- baseline-browser-mapping and caniuse-lite: incidentally added as direct
  dependencies, never imported. Both stay installed transitively through
  autoprefixer/browserslist, which is the only consumer. npm now records them
  as dev-only, since browserslist is a devDependency; that is safe here because
  every install path in this repo (Dockerfile, all three workflow jobs, Vercel)
  runs a plain `npm ci` with devDependencies included. No path uses
  --omit=dev or --production.

@types/file-saver stays: file-saver ships no declarations of its own.

Also removes two npm scripts and three dead Tailwind content globs:

- test:coverage, superseded by `npm test -- --coverage`. No workflow, script,
  or docs file invokes it. Two rows in .audit/crossfire.tsv do mention it, but
  those are historical records of August runs, not callers, and that log is
  deliberately left untouched.
- test:e2e:ui, which nothing references at all.
- the ./pages, ./components, and ./app content globs, for directories that do
  not exist in this repo.

The verify script keeps the docs:check step main added in #39.

Verified on main fe679fd, from a clean npm ci: docs:check, lint, typecheck,
956 unit tests, 121 edge tests, build, and 126 Chromium e2e tests pass.
Coverage 90.45% statements.

This branch was successfully deployed

1 active deployment
Preview — fd0a61e5 Deployed Sep 6, 2026 by vercel[bot]
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant