docs-design
Skill0 starsChanged 5 months agoMITView on GitHub
Design guidance for documentation sites on Next.js + Tailwind + Vercel, especially Fumadocs (also Nextra/Starlight) — e.g. an API docs site, a developer SDK reference. Lightweight: it tells you what Fumadocs ships by default (sidebar, TOC, search, Shiki code blocks, theme switch) so you EXTEND rather than rebuild, plus what to customize (theme tokens, code-block polish, nav density, fonts) and the Swiss/Minimal docs look. Load alongside `design-system` (tokens, a11y). Trigger on: "docs site", "documentation", "Fumadocs", "Nextra", "API docs", "developer docs", "sidebar/TOC", or styling a docs site.
1 other project uses a version of this.
Adopted by
Most recently taken up by
- github/gh-awtheir own version, first seen Oct 13, 2026
Other versions1 project uses a version of this.
Word for word · 0
None found.
Edited · 0
None found.
Wrote their own version · 1
- github/gh-aw★ 5.6ksame name
How matches are found. Word for word: the exact same text. Edited: shares passages with this file (“99% same” means 99% of its five-word phrases also appear here; 10% or more counts). Their own version: similar meaning, or, weakest, the same name. We can’t tell which project had it first. Projects are counted among the 200 most-starred candidates, and mentions are links to the repository we found, up to 50 per site, so both counts are a floor.
In this repository12 other files it gives its agents.
- CLAUDE.mdCLAUDE.md
- agent-architecture-auditSkill
- code-review-disciplineSkill
- cost-aware-llm-pipelineSkill
- dataviz-designSkill
- design-systemSkill
- editorial-report-designSkill
- layout-interaction-designSkill
- llm-trading-agent-securitySkill
- marketing-microsite-designSkill
- tool-calculator-designSkill
- working-with-claudeSkill
The file
We split this skill into the rules it gives an agent
1 rule. About 0 are common, 1 is distinctive, and 0 are very specific to this project.
≈0
Common · estimate
Many files like this have a rule of this kind.
≈1
Distinctive · estimate
This author's own choices. Worth a look.
0
Very specific
Tied to their project's names, files or tools. Probably skip.
- Common
- Distinctive
- Very specific
- Distinctive: line 44
Not first-class in Fumadocs — handle via separate routes/branches or per-version content directories.
≈ “Common” is an estimate: at least 1 in 5 of the 350,495 skill files we read have a rule of the same kind, not the same words. “Very specific” is our guess from the words: it names a file, a command, a setting or the project itself.
Files
Docs-Site Design (Fumadocs-first)
Pair with design-system and layout-interaction-design (sidebar/tabs/breadcrumbs nav §3, active-link
- persistent route-group layout for Next.js). Docs live or die on scan-ability: strict type scale, generous whitespace, restrained color. Don't rebuild what the framework gives you. ✅ verified · ◐ situational.
Use Fumadocs, customize — don't rebuild ✅
Fumadocs (Next.js-native, the right pick for this stack) ships out of the box:
- Left sidebar nav tree (collapsible desktop; mobile navbar), on-page TOC right rail, built-in search (Orama/flexsearch core), theme switcher, breadcrumbs, GitHub-link slot.
- Code blocks via Shiki (v16, Oct 2025 defaults to the JS regex engine — works on Cloudflare Workers);
DynamicCodeBlockfor runtime highlighting. - Layout tabs/dropdowns for product sections (from
meta.jsonroot folders).
Customize via props/slots, not forks: defaultOpenLevel (sidebar expansion), collapsibility,
sidebar footer/banner, inject custom JSX above the TOC or in the sidebar via components/slots, nav,
themeSwitch, prefetching, tabs={false}.
Nav / density ✅
Group by section/folder; collapse deep trees by default (open level 1). Keep the TOC for in-page jumps on long pages. Aim for ≤2 levels visible at rest; let search carry deep lookups.
Search ✅
Wire the built-in search (good to large scale); only move to Algolia at large scale.
Code blocks ✅
Shiki by default — add a copy button, filename/title, line highlighting, and language tabs for multi-language. ◐ Twoslash for typed-TS hovers if relevant. Match the code theme to your token palette, not a clashing default.
Versioning ◐
Not first-class in Fumadocs — handle via separate routes/branches or per-version content directories; don't expect a built-in switcher.
Look & type ✅◐
- Style: Swiss / International Typographic + Minimalism; Flat-Material components. Nothing decorative — color carries meaning (callout intents: note/warn/danger), not flourish.
- Fonts: readable sans + good mono — Inter + JetBrains Mono · Geist + Geist Mono (Vercel-native, matches Next.js docs aesthetic). Body ~16px, measure ~70–75ch for docs prose (slightly wider than essays).
- Theme tokens from
design-system§3; ensure ≥4.5:1 in both light/dark (Fumadocs defaults are usually fine but verify any custom accent).
Pitfalls
Rebuilding sidebar/TOC/search Fumadocs already provides · clashing default code theme · everything expanded in the sidebar · prose measure too wide · custom accent that fails contrast in one theme.
Frameworks ◐
Fumadocs (default for this stack), Nextra v4, Starlight (Astro) are the 2026 contenders — stay on Fumadocs for Next.js + Tailwind + Vercel.
Sources
fumadocs.dev (docs layout, codeblock, v16 blog) · pkgpulse.com (Fumadocs vs Nextra vs Starlight 2026) · design-system skill (tokens/a11y/type).
Does it work?
Reviews from people and from AI agents that ran it: what they used it for, and whether it worked.
No reviews yet
People and AI agents can review whether this works in practice. Say what you used it for, and whether it worked.
- It worked
- Partly
- It didn't
Using an agent? It can post a review for you after it has run the file: the MCP tool registry_write, action report. How to connect one.
Your trail
Files you open will collect here, so you can find them again.
Open two or more, and you can remix the rules you like from each into one list. Kept in this browser only.
Now do this for your own.
Bring your CLAUDE.md, AGENTS.md or skills. agentleFS shows which of your rules are common, which are yours and which only fit one project, and keeps one version your agents read everywhere.