docs: rework the README and add a Fumadocs documentation site#27
Conversation
|
Warning Review limit reached
Next review available in: 44 minutes Enable usage-based reviews in Billing to review now. Otherwise, wait until the next included review is available. How can I continue?After more reviews become available, a review can be triggered using the To avoid repeated limits, reduce automatic review volume by pausing incremental auto-reviews earlier, using label-based review opt-in, excluding WIP or generated PR titles, or requesting reviews manually when the PR is ready. If your team needs uninterrupted high-volume reviews, an organization admin can enable usage-based reviews. How do review limits work?CodeRabbit enforces per-developer PR review limits for each organization. Most developers receive the normal plan review availability. For paid Pro and Pro+ PR reviews, CodeRabbit uses adaptive limits for sustained high-volume activity. When a developer's recent PR review activity reaches the 95th percentile or higher among CodeRabbit users, additional reviews become available more gradually as earlier reviews age out of the rolling window. Please refer docs for additional details. Review details⚙️ Run configurationConfiguration used: Organization UI Review profile: ASSERTIVE Plan: Pro Plus Run ID: ⛔ Files ignored due to path filters (4)
📒 Files selected for processing (47)
📝 WalkthroughWalkthroughThis PR adds a Fumadocs-based static documentation site with multilingual routing, searchable content, MDX pages, LLM endpoints, generated metadata and images, static-link validation, and GitHub Pages deployment. README content is synchronized into the documentation landing page. ChangesDocumentation site
Estimated code review effort: 4 (Complex) | ~60 minutes Poem
🚥 Pre-merge checks | ✅ 4 | ❌ 1❌ Failed checks (1 warning)
✅ Passed checks (4 passed)
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. Comment |
Codecov Report✅ All modified and coverable lines are covered by tests. 📢 Thoughts on this report? Let us know! |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 4
🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
Inline comments:
In @.github/workflows/docs.yml:
- Around line 9-15: Update the paths list in the workflow trigger to include the
repository’s README.md alongside the existing docs and workflow patterns, so
README-only changes trigger the Pages build.
In `@docs/scripts/sync-readme.mjs`:
- Around line 10-11: Update the path setup near src and dest to derive the
script directory with dirname(fileURLToPath(import.meta.url)) instead of
import.meta.dirname, while preserving the existing README source and generated
destination resolution.
In `@README.md`:
- Line 1: Add a localized top-level H1 heading before the banner in README.md
(English), README.zh-CN.md (Simplified Chinese), and README.zh-TW.md
(Traditional Chinese), preserving the existing banner immediately after each
heading.
- Around line 220-221: Update the Linux uninstall command to use XDG-aware
parameter expansions for data, state, and config directories instead of
hardcoded defaults. Apply this change in README.md lines 220-221,
README.zh-CN.md lines 218-219, and README.zh-TW.md lines 218-219, preserving the
existing skit removal targets.
🪄 Autofix (Beta)
Fix all unresolved CodeRabbit comments on this PR:
- Push a commit to this branch (recommended)
- Create a new PR with the fixes
ℹ️ Review info
⚙️ Run configuration
Configuration used: Organization UI
Review profile: ASSERTIVE
Plan: Pro Plus
Run ID: 27050559-f4c2-4c2a-a9ee-df7182187c25
⛔ Files ignored due to path filters (4)
docs/app/icon.pngis excluded by!**/*.pngdocs/assets/demo-en.mp4is excluded by!**/*.mp4docs/assets/demo-zh.mp4is excluded by!**/*.mp4docs/package-lock.jsonis excluded by!**/package-lock.json
📒 Files selected for processing (47)
.github/workflows/docs.yml.gitignoreAGENTS.mdREADME.mdREADME.zh-CN.mdREADME.zh-TW.mddocs/.gitignoredocs/README.mddocs/app/[lang]/(home)/layout.tsxdocs/app/[lang]/(home)/page.tsxdocs/app/[lang]/(home)/redirect-to-docs.tsxdocs/app/[lang]/docs/[[...slug]]/page.tsxdocs/app/[lang]/docs/layout.tsxdocs/app/[lang]/layout.tsxdocs/app/api/search/route.tsdocs/app/global.cssdocs/app/llms-full.txt/route.tsdocs/app/llms.mdx/docs/[[...slug]]/route.tsdocs/app/llms.txt/route.tsdocs/app/og/docs/[...slug]/route.tsxdocs/components/mdx.tsxdocs/components/provider.tsxdocs/components/search.tsxdocs/content/docs/ai-agents.mdxdocs/content/docs/cli.mdxdocs/content/docs/configuration.mdxdocs/content/docs/environment.mdxdocs/content/docs/index.mdxdocs/content/docs/meta.jsondocs/content/docs/parameters.mdxdocs/content/docs/prompts.mdxdocs/content/docs/script-types.mdxdocs/content/docs/troubleshooting.mdxdocs/lib/cn.tsdocs/lib/i18n.tsdocs/lib/layout.shared.tsxdocs/lib/shared.tsdocs/lib/source.tsdocs/next.config.mjsdocs/package.jsondocs/postcss.config.mjsdocs/public/.nojekylldocs/public/index.htmldocs/scripts/check-links.mjsdocs/scripts/sync-readme.mjsdocs/source.config.tsdocs/tsconfig.json
| @@ -1,4 +1,4 @@ | |||
|  | |||
| <img src="https://raw.githubusercontent.com/t41372/skit/main/docs/assets/banner.png" alt="skit — script launcher and parameter manager" width="750"> | |||
There was a problem hiding this comment.
📐 Maintainability & Code Quality | 🟡 Minor | ⚡ Quick win
Add a top-level heading before each README banner.
All three README variants fail the first-line heading check and are used as user-facing landing documents.
README.md#L1-L1: add the English H1 before the banner.README.zh-CN.md#L1-L1: add the Simplified Chinese H1 before the banner.README.zh-TW.md#L1-L1: add the Traditional Chinese H1 before the banner.
🧰 Tools
🪛 markdownlint-cli2 (0.23.0)
[warning] 1-1: First line in a file should be a top-level heading
(MD041, first-line-heading, first-line-h1)
📍 Affects 3 files
README.md#L1-L1(this comment)README.zh-CN.md#L1-L1README.zh-TW.md#L1-L1
🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
In `@README.md` at line 1, Add a localized top-level H1 heading before the banner
in README.md (English), README.zh-CN.md (Simplified Chinese), and
README.zh-TW.md (Traditional Chinese), preserving the existing banner
immediately after each heading.
Source: Linters/SAST tools
…tions Retune the English intro and "what it does" copy, render the run screen as the "launch menu" throughout, and cap the banner width so it reads as a banner instead of filling the pane. Bring README.zh-TW / README.zh-CN in sync with the reworked copy. Stop tracking the generated demo videos (docs/assets/demo-*.mp4) — they're uploaded to GitHub user-attachments, and tracking them balloons history.
A static-export Fumadocs site under docs/, deployed to GitHub Pages via .github/workflows/docs.yml (zizmor-clean, SHA-pinned actions). The landing page renders the repo README; deep-reference pages — CLI, parameters, environment variables, configuration, script types, prompts, AI agents, and troubleshooting — cover detail the README leaves out. English-only for now, with the i18n structure already in place. A build-time link checker (docs/scripts/check-links.mjs) fails the build on any broken internal link or anchor. AGENTS.md documents how to edit the docs.
|
Addressed the CodeRabbit review (folded into the existing two commits):
Verified: docs build + link checker green, |
1 participant
Two logical changes, one per commit.
README rework
<img width>) so it renders as a banner instead of filling the pane in GitHub / VS Code / the docs landing.README.zh-TWandREADME.zh-CNwith the reworked copy (idiomatic, not literal) and aligned the PromptRunner term (執行器 / 执行器) with the product UI.docs/assets/demo-*.mp4) — they're uploaded to GitHub user-attachments, so tracking them only balloons history.Documentation site
docs/, deployed to GitHub Pages by.github/workflows/docs.yml(zizmor-clean, every action SHA-pinned).docs/scripts/check-links.mjs) fails the build on any broken internal link or#anchor.AGENTS.mddocuments how to edit the docs.After merge (manual, one-time)
https://claude.ai/code/session_019FQ5d3ryWn6nxkaQ5VsDZm
Summary by CodeRabbit
New Features
Documentation