Skip to content

Port docs from Fumadocs to FrontLit - #204

Merged
s3rot0n1n merged 3 commits into
mainfrom
docs/port-fumadocs-to-frontlit
Nov 14, 2026
Merged

s3rot0n1n merged 3 commits into
mainfrom
docs/port-fumadocs-to-frontlit

Conversation

@s3rot0n1n

@s3rot0n1n s3rot0n1n commented Nov 14, 2026 •

Copy link
Copy Markdown
Contributor

Ports the Fumadocs site in apps/docs into a FrontLit docs folder, frontlit/docs/. Only the syntax changes: the wording, examples and page order are the same. The old Fumadocs app is not modified or removed. Retiring it can be a separate PR after the result is checked on FrontLit.

Pages and sections

_sections.json defines one section per old Fumadocs group, in the order of the root meta.json:

Section Pages
Getting Started Introduction, Overview
Teams Team members and permissions
Self hosting FrontLit Self Hosting Guide, Set up the documentation GitHub App
Components Page builder, Text editor
Developers Overview, Authentication, MCP connections, Pages from Git

11 pages, .mdx → .md. Internal links are rewritten to /docs/.... The bundled frontlit-docs checker passes (OK: 11 file(s), 11 route(s)) with --api-mount=api-reference.

URLs

The old site was served at the root, so every page moves under /docs with the same path. For example, /getting-started/overview becomes /docs/getting-started/overview.

  • Introduction: / → /docs/getting-started/introduction. A root index.md would not replace the FrontLit docs home, so the page now sits first in Getting Started.

Removed widgets

  • components/page-builder: <PageBuilderDemo /> (live builder) is removed and replaced by a sentence pointing to the Usage section and examples/components-demo.
  • components/text-editor: <TextEditorDemo /> (live editor) is removed the same way.

Other edits

  • self-hosting/github-app: two bold-around-inline-code spans (root .env, apps/api/.env) are now plain inline code. FrontLit does not support bold or italic around inline code.

⚠️ API reference is not ported (action needed)

The old /api-reference section is generated at build time from the ts-rest contract (apps/docs/lib/openapi.ts), and no spec file is committed. FrontLit can only publish an API reference from a committed OpenAPI 3.x spec, so these pages are skipped.

Because no API reference is configured yet, the three "API Reference" links (Introduction, Developers/Overview, Authentication) point to the live Swagger UI at https://api.frontlit.app/docs/. With /docs/api-reference they failed validation with BROKEN_LINK.

To publish it on FrontLit later:

  1. Commit a spec export, for example the output of generateOpenApi(contract, …), ideally kept current by CI.
  2. Set its path in Settings → Integrations → GitHub, with URL path api-reference.
  3. Switch the three links back to /docs/api-reference.

The whole spec becomes public, including /openapi.json. Use x-internal: true to hide operations. Operation URLs come from operationId / summary, so they will differ from fumadocs-openapi's.

Before merging

  • FrontLit / docs validation passes: 11 managed files, 11 public docs. This branch merges main to pick up FrontLit's setup PR (Set up FrontLit documentation #203), whose empty _sections.json is replaced here.
  • Merging publishes the pages.

🤖 Generated with Claude Code

Copy the apps/docs content into frontlit/docs as FrontLit Markdown with
_sections.json. The old Fumadocs app is left in place.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
@chatgpt-codex-connector

chatgpt-codex-connector Bot commented Nov 14, 2026 •

Copy link
Copy Markdown
Codex Review Summary: ✅ Completed

This comment shows the latest Codex review activity on this pull request.

Review Status Commit Review trigger
📝 Code Review ✅ Completed 2026-11-14T04:44:26.824661Z 65c6be9 PR opened
ℹ️ About Codex in GitHub

Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you

  • Open a pull request for review
  • Mark a draft as ready
  • Comment "@codex review" or "@codex security review".

Codex reacts with 👀 while any review is running, comments if it has suggestions, and reacts with 👍 once all reviews finish with no findings.

Rajat and others added 2 commits November 14, 2026 10:09
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
FrontLit has no API reference configured yet, so /docs/api-reference
links fail validation.

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

@chatgpt-codex-connector chatgpt-codex-connector Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

💡 Codex Review

Here are some automated review suggestions for this pull request.

Reviewed commit: 65c6be9776

ℹ️ About Codex in GitHub

Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you

  • Open a pull request for review
  • Mark a draft as ready
  • Comment "@codex review".

If Codex has suggestions, it will comment; otherwise it will react with 👍.

Codex can also answer questions or update the PR. Try commenting "@codex address that feedback".

- **[Self-hosting](/docs/self-hosting)** — run SendLit and its dependencies with Docker Compose.
- **[Components](/docs/components/page-builder)** — install and use `@frontlit/page-builder` and `@frontlit/text-editor`.
- **[Developers](/docs/developers/overview)** — authentication, teams, and API keys.
- **[API Reference](/docs/api-reference)** — the full REST API, generated from the same contract the server validates against.

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

P2 Badge Configure the API reference before linking to it

If this folder is published before the external API-reference setup is completed, /docs/api-reference has no target: this commit adds no FrontLit OpenAPI spec, and the repository contains only generated FrontLit specs, not a committed one. The API-reference links in these docs will then lead to missing pages; include and configure the spec before publication, or defer the links.

Useful? React with 👍 / 👎.

@s3rot0n1n
s3rot0n1n merged commit 26e1648 into main Nov 14, 2026
4 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