Skip to content

Teach frontlit-docs the MediaLit port lessons; simplify the README - #11

Merged
clbotdev merged 1 commit into
mainfrom
docs/medialit-port-lessons
Nov 4, 2026
Merged

clbotdev merged 1 commit into
mainfrom
docs/medialit-port-lessons

Conversation

@clbotdev

@clbotdev clbotdev commented Nov 4, 2026

Copy link
Copy Markdown
Collaborator

Lessons from porting MediaLit's Fumadocs site to FrontLit (codelitdev/medialit#239), plus a README for newcomers.

frontlit-docs

  • Checker flag: SKILL.md now documents --api-mount=<url-path>. Without it, links to API reference pages are reported as broken (3 false failures on MediaLit's docs; passes with --api-mount=api).
  • Setup: connecting a repository without a FrontLit folder opens a setup PR; merge it first. Explains adding a missing GitHub organization.
  • Formatter: run the repo's Markdown formatter, then the checker again (Prettier failed 8 MediaLit pages in CI).
  • Anchors: format.md states the exact heading-ID rule (each run of spaces → one hyphen). porting.md warns that Fumadocs/Docusaurus/GitHub -- anchors change. New checker test locks this in; the checker code was already correct.
  • Images: an image right after a line of text renders inline; keep it in its own paragraph.
  • "Try it" CORS: allow only the docs origin on API-key routes, not *; report it and change the API in a separate PR.
  • Redirects and retiring the old site: redirect domains (DNS records, /docs path prefix, renamed paths), checking every old URL, and a retirement checklist. DNS and hosting stay with the user.
  • Links MediaLit's frontlit/docs as the reference port.

README

Rewritten for beginners: what a skill is, prerequisites, install per agent, example requests and what happens after, optional account connection, and things to know before merging. Maintainer notes moved verbatim to CONTRIBUTING.md.

Plugin version bumped to 0.2.1.

- Document the checker's --api-mount flag, the GitHub setup pull request,
  running the repo's formatter, FrontLit's heading anchors and block images.
- Rewrite redirects as a redirect-domain and retirement checklist, and
  recommend docs-origin-only CORS for "Try it" on API-key routes.
- Make the README a beginner guide; move maintainer notes to CONTRIBUTING.md.
- Bump the plugin to 0.2.1.
@clbotdev
clbotdev merged commit f1363dc into main Nov 4, 2026
1 check 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