Skip to content

Add Fumadocs plugin/theme API site - #1

Merged
tomymaritano merged 1 commit into
mainfrom
cursor/developers-fumadocs-c3e3
Aug 26, 2026
Merged

Add Fumadocs plugin/theme API site#1
tomymaritano merged 1 commit into
mainfrom
cursor/developers-fumadocs-c3e3

Conversation

@tomymaritano

@tomymaritano tomymaritano commented Aug 26, 2026

Copy link
Copy Markdown
Contributor

Fumadocs + Next.js static-export site for developers.dripnex.app, modeled on developers.inkdrop.app. Tooling matches dripnex/docs-site (pnpm, Fumadocs, Cloudflare Pages project dripnex-developers).

Content

  • Home: “Start building with the Dripnex API” plus getting-started, guides, and resources.
  • Getting started: plugin repo layout / manifest / CJS loader, init.js (InitApi / dripnex — host plugin-api, not Inkdrop Atom APIs), styles.css and theme tokens.
  • Guides: create a plugin, create a theme (CORE_THEME_TOKENS / THEME_EXTENSION_SCOPES / theme.json), publishing via git tag + dripnex-plugin pack GitHub release. No public marketplace.
  • API reference from live packages/plugin-api on develop (PluginContext, commands, editor, themes, layout zones, DataAPI). Stale docs-site methods (getTheme, themeType, 9-zone list) are not copied.
  • Official satellites verified on GitHub: plugin-stamp, plugin-mermaid / plugin-math (insert snippets, not renderers), plugin-vim, theme-*.
  • Cross-links: docs.dripnex.app, dripnex.app/plugins.

Deploy

Pages project dripnex-developersdripnex-developers.pages.dev. When DNS is ready: CNAME developersdripnex-developers.pages.dev.

Build (pnpm build) will be verified on this PR after install.

Open in Web Open in Cursor 

Summary by CodeRabbit

  • New Features

    • Launched a searchable Dripnex developer documentation site with navigation, metadata, table of contents, code examples, and custom 404 handling.
    • Added comprehensive guides for getting started, creating plugins and themes, publishing packages, and customizing styles.
    • Added API references covering commands, data, editor extensions, layout zones, plugin context, themes, and practical examples.
    • Added dark-theme styling, branded navigation, and links to product, user documentation, and plugins.
  • Documentation

    • Added local development, deployment, environment configuration, and repository guidance.
  • Chores

    • Added automated type-checking and build validation through continuous integration.

Static-export Next.js site for developers.dripnex.app, sourced from
@dripnex/plugin-api types (PluginContext, tokens, layout zones) rather
than stale user-manual MDX. Publish path is git tag + packed GitHub
release; no marketplace.

Co-authored-by:  Tomás Maritano <tomymaritano@gmail.com>
@coderabbitai

coderabbitai Bot commented Aug 26, 2026

Copy link
Copy Markdown

Review Change Stack

Caution

Review failed

The pull request is closed.

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro Plus

Run ID: 3ed6dd0b-4858-4c46-a7bf-be8273afaf76

📥 Commits

Reviewing files that changed from the base of the PR and between 1040a0b and eddabc9.

⛔ Files ignored due to path filters (5)
  • public/apple-touch-icon.png is excluded by !**/*.png
  • public/favicon.ico is excluded by !**/*.ico
  • public/favicon.png is excluded by !**/*.png
  • public/icon.png is excluded by !**/*.png
  • public/logo.png is excluded by !**/*.png
📒 Files selected for processing (36)
  • .env.example
  • .github/workflows/ci.yml
  • .gitignore
  • README.md
  • app/[[...slug]]/page.tsx
  • app/globals.css
  • app/layout.tsx
  • app/not-found.tsx
  • content/docs/getting-started/index.mdx
  • content/docs/getting-started/init-file.mdx
  • content/docs/getting-started/meta.json
  • content/docs/getting-started/style-tweaks.mdx
  • content/docs/guides/create-a-plugin.mdx
  • content/docs/guides/create-a-theme.mdx
  • content/docs/guides/meta.json
  • content/docs/guides/publishing.mdx
  • content/docs/index.mdx
  • content/docs/meta.json
  • content/docs/reference/commands.mdx
  • content/docs/reference/data.mdx
  • content/docs/reference/editor.mdx
  • content/docs/reference/examples.mdx
  • content/docs/reference/layout-zones.mdx
  • content/docs/reference/meta.json
  • content/docs/reference/plugin-context.mdx
  • content/docs/reference/themes.mdx
  • lib/layout.shared.tsx
  • lib/site.ts
  • lib/source.ts
  • mdx-components.tsx
  • next-env.d.ts
  • next.config.mjs
  • package.json
  • postcss.config.mjs
  • source.config.ts
  • tsconfig.json

📝 Walkthrough

Walkthrough

Added the Dripnex developer documentation site. The change includes Next.js and Fumadocs setup, static documentation routes, shared navigation and styling, CI configuration, and comprehensive plugin, theme, publishing, and API reference content.

Changes

Documentation site

Layer / File(s) Summary
Project foundation
.env.example, .github/workflows/ci.yml, .gitignore, README.md, package.json, next.config.mjs, postcss.config.mjs, source.config.ts, tsconfig.json, next-env.d.ts
Adds project configuration, environment variables, CI checks, deployment scripts, repository metadata, and local development instructions.
Documentation rendering and site shell
app/*, app/[[...slug]]/page.tsx, lib/*, mdx-components.tsx
Connects Fumadocs content to static routes, metadata, MDX components, navigation, the root layout, and the custom 404 page.
Getting started content
content/docs/getting-started/*
Documents plugin structure, manifests, initialization files, declarative package files, and style customization.
Plugin, theme, and publishing guides
content/docs/guides/*
Documents plugin and theme creation, packaging, installation, GitHub release publishing, and Browse index requirements.
API reference and examples
content/docs/index.mdx, content/docs/meta.json, content/docs/reference/*
Adds reference documentation for plugin context, commands, data, editor extensions, layout zones, themes, and plugin examples.

Estimated code review effort: 3 (Moderate) | ~25 minutes

Sequence Diagram(s)

sequenceDiagram
  participant Browser
  participant NextRoute
  participant FumadocsSource
  participant MDXComponents
  Browser->>NextRoute: Request documentation slug
  NextRoute->>FumadocsSource: Load page and metadata
  FumadocsSource-->>NextRoute: Return content and table of contents
  NextRoute->>MDXComponents: Render MDX body
  MDXComponents-->>Browser: Return rendered documentation page
Loading
✨ Finishing Touches 💡 1
🛠️ Fix failing CI checks 💡
  • Create stacked PR
  • Commit on current branch
📝 Generate docstrings
  • Create stacked PR
  • Commit on current branch
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch cursor/developers-fumadocs-c3e3

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.

❤️ Share

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

@tomymaritano
tomymaritano marked this pull request as ready for review August 26, 2026 02:53
@tomymaritano
tomymaritano merged commit 0b553c0 into main Aug 26, 2026
0 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.

2 participants