Skip to content

Add Fumadocs documentation site with auto-generated API reference#4

Merged
Segfaultd merged 10 commits intomainfrom
add-documentation
Apr 10, 2026
Merged

Add Fumadocs documentation site with auto-generated API reference#4
Segfaultd merged 10 commits intomainfrom
add-documentation

Conversation

@Segfaultd
Copy link
Copy Markdown
Contributor

Summary

  • Adds a complete documentation site built with Fumadocs (Next.js) in docs/
  • 75 pages covering Getting Started, Guides, API Reference, and Architecture
  • API Reference (62 pages) auto-generated from a 3500-line OpenAPI 3.1 spec via fumadocs-openapi
  • Beautiful default theme with dark mode, full-text search, and responsive layout

Content

Section Pages Description
Getting Started 3 Installation, Quick Start, Connecting the SDK
Guides 5 Webhooks, Test Clocks, 3DS, Dashboard, Idempotency
API Reference 62 Auto-generated from OpenAPI spec for all 13 resources
Architecture 4 Overview, Request Lifecycle, Services, Contributing

Usage

cd docs
bun install
bun run dev       # Dev server at localhost:3000
bun run build     # Production build
bun run generate  # Regenerate API docs from openapi.json

Test plan

  • bun run build succeeds (75 static pages generated)
  • All 13 API resources have generated reference pages
  • Visual check: bun run dev and browse all sections

- Pin fumadocs packages to v15-compatible versions (fumadocs-ui@15.8.5,
  fumadocs-core@15.8.5, fumadocs-mdx@12.0.3, fumadocs-openapi@6.3.0)
- Fix CSS imports to use neutral.css + preset.css with @source directives
- Fix source.ts to use toFumadocsSource() API
- Fix page component imports from fumadocs-ui/page
- Fix OpenAPI integration for v6 API (createOpenAPI, generateFiles)
- Use application/json in OpenAPI spec for docs rendering compatibility
- Use turbopack for build
- Add .gitignore for docs
- Add Documentation link to README
- Configure Next.js static export (output: 'export')
- Add docs.yml workflow: builds on push to main (docs/** paths), deploys to GitHub Pages
- Add out/ to docs .gitignore
@Segfaultd Segfaultd merged commit 91d8f85 into main Apr 10, 2026
2 checks passed
@Segfaultd Segfaultd deleted the add-documentation branch April 10, 2026 08:56
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