Skip to content

docs: create documentation application #7

Merged
remcostoeten merged 5 commits intomasterfrom
feature/docs
Sep 20, 2025
Merged

docs: create documentation application #7
remcostoeten merged 5 commits intomasterfrom
feature/docs

Conversation

@remcostoeten
Copy link
Owner

@remcostoeten remcostoeten commented Sep 20, 2025

…monospace headings, expanded FAQ & components; soften guidance

Summary by CodeRabbit

  • New Features
    • Added new docs sections: Support & Scope and Smart Connection Architecture.
    • FAQ redesigned with interactive accordion.
  • Documentation
    • Standardized code blocks with filenames/titles across guides and API pages.
    • Expanded installation with SQLite driver example and clearer verification steps.
    • Refreshed landing content and examples highlighting connection setup and CRUD helpers.
    • Updated best practices for server actions, typing, and state management.
  • Style
    • New gradient branding in header and monospace typography for headings/code.
    • Enhanced code block UI for better readability.
  • Chores
    • Docs now display last modified time sourced from Git.

@coderabbitai
Copy link

coderabbitai bot commented Sep 20, 2025

Caution

Review failed

The pull request is closed.

Walkthrough

Documentation MDX files were updated to add filename/title metadata to code fences, new docs were added, and several docs were restructured. The docs site config gains a lastModifiedTime option. Styling updates include monospace fonts and gradient branding. MDX rendering now wraps pre/code blocks with fumadocs CodeBlock/Pre components.

Changes

Cohort / File(s) Summary
Docs: add filename/title metadata to code fences
apps/docs/content/docs/01-getting-started.mdx, .../02-installation.mdx, .../03-quickstart.mdx, .../10-where-clauses.mdx, .../20-api/01-core.mdx, .../20-api/04-database-connection.mdx, .../20-api/05-react-client.mdx, .../20-api/06-production-utilities.mdx, .../40-examples.mdx
Annotated code fences with filename/title keys; no code semantics changed.
Docs: types where clause expansion
apps/docs/content/docs/20-api/07-types.mdx
Extended documented TWhereClause union to include comparison and wildcard string patterns; other type blocks now include filenames.
New docs: Support & Scope
apps/docs/content/docs/04-support-and-scope.mdx
Added page listing supported items, exclusions, and philosophy.
New docs: Smart Connection Architecture
apps/docs/content/docs/12-connection-architecture.mdx
Added page detailing provider detection, schema loading, connection caching, env-aware tuning, and multi-DB examples.
Docs: Best Practices refresh
apps/docs/content/docs/50-best-practices.mdx
Revised guidance emphasizing server actions, typing, pure reducers, and export conventions.
Docs: FAQ accordion UI
apps/docs/content/docs/60-faq.mdx
Replaced plain sections with Accordion-based Q&A; content organized into collapsible items.
Docs: Index overhaul
apps/docs/content/docs/index.mdx
Reworked intro using Files/File components; new example blocks for db connection and user actions; updated navigation cards.
Docs: Test page content swap
apps/docs/content/docs/test.mdx
Replaced prior samples with optimistic client hook, transition utility, and server actions examples.
Docs site config
apps/docs/source.config.ts
Added lastModifiedTime: 'git' to exported config.
Site styling: fonts
apps/docs/src/app/global.css
Added --font-mono and applied monospace to headings and code elements.
Branding visuals
apps/docs/src/lib/layout.shared.tsx
Introduced gradient SVG fill and gradient-styled “Drizzleasy” text.
MDX rendering pipeline
apps/docs/src/mdx-components.tsx
Now wraps pre blocks with fumadocs CodeBlock and Pre; imports added and render path adjusted.

Sequence Diagram(s)

sequenceDiagram
  autonumber
  participant U as User
  participant N as Next.js App Router
  participant MDX as MDX Renderer
  participant C as getMDXComponents()
  participant CB as CodeBlock/Pre

  U->>N: Request docs page
  N->>MDX: Render MDX content
  MDX->>C: Resolve components
  C-->>MDX: MDXComponents (pre overridden)
  MDX->>CB: Render <pre> blocks via CodeBlock + Pre
  Note right of CB: Uses filename/title metadata from code fences
  CB-->>MDX: Rendered code block
  MDX-->>N: Page HTML
  N-->>U: Response
Loading

Estimated code review effort

🎯 3 (Moderate) | ⏱️ ~25 minutes

Poem

I hop through docs with gentle cheer,
New gradients glow, code blocks appear.
Filenames whisper, “read me right,”
Accordions fold the FAQs tight.
With CodeBlock carrots crisp and bright,
I nibble bytes by moonlit night. 🥕✨


📜 Recent review details

Configuration used: CodeRabbit UI

Review profile: CHILL

Plan: Free

📥 Commits

Reviewing files that changed from the base of the PR and between 37ee011 and fc74441.

📒 Files selected for processing (20)
  • apps/docs/content/docs/01-getting-started.mdx (6 hunks)
  • apps/docs/content/docs/02-installation.mdx (3 hunks)
  • apps/docs/content/docs/03-quickstart.mdx (6 hunks)
  • apps/docs/content/docs/04-support-and-scope.mdx (1 hunks)
  • apps/docs/content/docs/10-where-clauses.mdx (1 hunks)
  • apps/docs/content/docs/12-connection-architecture.mdx (1 hunks)
  • apps/docs/content/docs/20-api/01-core.mdx (5 hunks)
  • apps/docs/content/docs/20-api/04-database-connection.mdx (3 hunks)
  • apps/docs/content/docs/20-api/05-react-client.mdx (2 hunks)
  • apps/docs/content/docs/20-api/06-production-utilities.mdx (4 hunks)
  • apps/docs/content/docs/20-api/07-types.mdx (3 hunks)
  • apps/docs/content/docs/40-examples.mdx (2 hunks)
  • apps/docs/content/docs/50-best-practices.mdx (1 hunks)
  • apps/docs/content/docs/60-faq.mdx (1 hunks)
  • apps/docs/content/docs/index.mdx (1 hunks)
  • apps/docs/content/docs/test.mdx (1 hunks)
  • apps/docs/source.config.ts (1 hunks)
  • apps/docs/src/app/global.css (1 hunks)
  • apps/docs/src/lib/layout.shared.tsx (1 hunks)
  • apps/docs/src/mdx-components.tsx (1 hunks)

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 Pro by visiting https://app.coderabbit.ai/login.

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

@remcostoeten remcostoeten merged commit 1c48c73 into master Sep 20, 2025
1 of 2 checks passed
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