Repository navigation
Port docs from Fumadocs to FrontLit - #204
Conversation
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>
Codex Review Summary: ✅ CompletedThis comment shows the latest Codex review activity on this pull request.
ℹ️ About Codex in GitHubYour team has set up Codex to review pull requests in this repo. Reviews are triggered when you
Codex reacts with 👀 while any review is running, comments if it has suggestions, and reacts with 👍 once all reviews finish with no findings. |
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>
There was a problem hiding this comment.
💡 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. |
There was a problem hiding this comment.
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 👍 / 👎.
Ports the Fumadocs site in
apps/docsinto 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.jsondefines one section per old Fumadocs group, in the order of the rootmeta.json:11 pages,
.mdx→.md. Internal links are rewritten to/docs/.... The bundledfrontlit-docschecker 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
/docswith the same path. For example,/getting-started/overviewbecomes/docs/getting-started/overview./→/docs/getting-started/introduction. A rootindex.mdwould 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 andexamples/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.The old
/api-referencesection 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-referencethey failed validation withBROKEN_LINK.To publish it on FrontLit later:
generateOpenApi(contract, …), ideally kept current by CI.api-reference./docs/api-reference.The whole spec becomes public, including
/openapi.json. Usex-internal: trueto hide operations. Operation URLs come fromoperationId/summary, so they will differ from fumadocs-openapi's.Before merging
FrontLit / docs validationpasses: 11 managed files, 11 public docs. This branch mergesmainto pick up FrontLit's setup PR (Set up FrontLit documentation #203), whose empty_sections.jsonis replaced here.🤖 Generated with Claude Code