Skip to content

docs: rewrite docs as feature-oriented site#2163

Merged
koistya merged 13 commits intomainfrom
dev
Feb 18, 2026
Merged

docs: rewrite docs as feature-oriented site#2163
koistya merged 13 commits intomainfrom
dev

Conversation

@koistya
Copy link
Member

@koistya koistya commented Feb 18, 2026

Summary

  • Restructure flat documentation (4 mega-files) into 46 focused pages organized by feature: getting-started, architecture, frontend, api, auth, database, billing, email, testing, deployment, recipes, and security
  • Split getting-started.md (~670 lines), database-schema.md (~670 lines), deployment.md (~475 lines), and ui-components.md (~387 lines) into dedicated sections
  • Add new documentation for architecture overview, edge routing, API layer, authentication flows, billing/Stripe, email, testing, and 6 recipe guides
  • Update VitePress sidebar with collapsed feature groups and fix Mermaid component HTML escaping
  • Bump dependencies: tailwindcss 4.2, wrangler 4.66, vitepress alpha.16, hono 4.11.10, lucide-react 0.574, and others

New documentation sections

getting-started/   4 pages (intro, quick start, project structure, env vars)
architecture/      2 pages (overview with Mermaid diagram, edge routing)
frontend/          4 pages (routing, state & data fetching, UI, forms)
api/               4 pages (overview, procedures, validation & errors, context)
auth/              6 pages (overview, email OTP, social, passkeys, orgs, sessions)
database/          5 pages (overview, schema, migrations, seeding, queries)
billing/           4 pages (overview, plans, checkout, webhooks)
deployment/        5 pages (overview, cloudflare, prod DB, CI/CD, monitoring)
recipes/           6 pages (new page, procedure, table, teams, websockets, uploads)
+ email.md, testing.md

https://reactstarter.com/getting-started/

Test plan

  • bun typecheck passes
  • bun lint passes
  • VitePress dev server renders all pages with correct sidebar navigation
  • All internal cross-links resolve correctly

Split the flat doc structure (getting-started, database-schema, deployment,
ui-components) into focused per-feature sections: getting-started, architecture,
frontend, api, auth, database, billing, email, testing, deployment, and recipes.

Update VitePress sidebar with collapsed feature groups, fix Mermaid HTML
escaping, and bump mermaid/vitepress deps.
- ER diagram: add missing functional columns across all tables
- Fix dev connection description (getPlatformProxy, not direct URL)
- Fix DataLoader example to use actual Map API with Symbol keys
- Add db:typecheck to commands table
- Remove "introspect" from scripts/ description (not a custom script)
- Remove stale setup-extensions.sql (pg_uuidv7 artifact)
Replace per-loader cache boilerplate with a `defineLoader` factory that
encapsulates instance caching, type casting, and batch function wiring.
Combine `createKeyMap` + manual mapping into a single `mapByKey` helper.
- Fix undefined variable in simplified worker.ts example
- Add missing context fields (info, res) to TRPCContext table
- Update createContext example with null guards and batching
- Add missing ai.ts and email.ts to project structure
- Show actual errorHandler header-merging behavior
- Add undocumented GET / redirect to endpoints table
- Fix health check response description
- Add missing emailAndPassword and emailVerification config to overview
- Add trustedOrigins and allowUserToCreateOrganization to server snippet
- Fix signOut signature to include optional redirect parameter
- Add missing acceptedAt/rejectedAt columns to invitation table
- Fix INVALID_OTP error description to reflect server message fallback
- Clarify OtpStep as internal AuthForm component in tree diagram
Architecture: fix createDb variable pattern in middleware snippet,
add /api info endpoint to table, replace hardcoded Hyperdrive cache
duration with generic labels, add onnotice option to createDb snippet,
correct infra/envs/ description.

Getting started: add GOOGLE_CLOUD_PROJECT and OPENAI_API_KEY env vars,
fix Web dev server port and app route path.
- Fix Happy DOM GitHub link (nicknisi → capricorn86)
- Fix --project filter names (api/app → @repo/api/@repo/app)
- Fix bun test comment (watch mode by default, not single run)
- Remove nonexistent bun app:coverage command
- Sync tRPC test context mock with actual billing.test.ts
- Add missing vi import in component test example
- Clarify which project uses which vitest config style
- Fix email template descriptions and env var defaults
- new-procedure: add missing `schema` import for insert operation
- teams: show full column definitions, precise auth config, add
  client-side setup and usage examples (create/list/manage teams)
- file-uploads: rewrite broken upload flow — use aws4fetch presigned
  PUT URLs instead of incorrect createMultipartUpload, fix path
  mismatches, add proper error handling and R2 credential setup
Workspace READMEs now orient developers with a one-liner, doc links,
key commands, and directory structure — detailed content lives on the
docs site. Cuts ~1,650 lines of duplicated, drift-prone prose.
@koistya koistya merged commit 3c5132e into main Feb 18, 2026
8 checks passed
@koistya koistya deleted the dev branch February 18, 2026 19:26
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