mirror of
https://github.com/Rohithgilla12/data-peek
synced 2026-04-21 21:07:17 +00:00
f9a58e76b5
* docs(plan): add docs site revamp design Root-causes the slow layout transitions on docs.datapeek.dev (Framer Motion 500ms fade, sidebar tree re-sent per nav, version lag) and plans phased fix: triage, version bumps, MDX brittleness, prerender, brand polish, follow-up distinctive design pass. * docs(plan): add docs site revamp implementation plan Phased tasks covering Framer Motion / tree-reload removal, version bumps (Fumadocs 16.7, TanStack 1.168), remark plugins for resilient MDX parsing, CI types:check gate, prerender, and typography polish. Validation checklist at the end. * perf(docs): remove page fade-in and move tree to parent route Framer Motion wrapper added a 500ms fade on every nav and the sidebar tree was re-sent and re-transformed per navigation. Move the tree to a new /docs parent layout route with staleTime:Infinity and drop the motion wrapper + CSS fade-in on main. Navigating /docs/* now feels instant. * chore(docs): bump fumadocs to 16.7 / 14.2 and switch to useContent fumadocs-ui/core 16.2.1 -> 16.7.x and fumadocs-mdx 14.0.4 -> 14.2.x. fumadocs-mdx 14.2 tightened ClientLoader typings so getComponent() returns FC<never> by default. Switch to clientLoader.useContent() which is the canonical Fumadocs-on-TanStack pattern anyway — cleaner and handles Suspense internally. * chore(docs): bump tanstack router/start to 1.168/1.167 Bumps @tanstack/react-router to ^1.168.10, @tanstack/react-start to ^1.167.16, and @tanstack/react-router-devtools to ^1.166.11. Catches ~34 minor versions of hydration, loader, scroll restoration, and routing fixes. No source changes required - existing createFileRoute, createServerFn, inputValidator, and createRouter APIs remain compatible. * fix(docs): harden MDX parsing and add types:check CI gate Add remark-gfm + remark-smartypants to fumadocs MDX config so prose containing numeric operators, comparisons, and angle brackets parses cleanly without author discipline. The workaround from60282cd(backtick-wrapping operators) is no longer strictly needed, though we leave existing wrappers in place. Add .github/workflows/docs-types.yml that runs pnpm --filter docs types:check on every PR touching apps/docs. This parses every MDX file and fails the build if anything regresses — catches the kind of issue that hit prod in60282cd. * docs(plan): capture post-revamp perf baseline and defer prerender Prerender attempted but blocked by a race between tanstack-start- plugin-core and nitro@3.0.1-alpha.1 in the preview-server handoff (fetches the first route before the nitro child process has bound to its port). Runtime is fine — only the prerender crawl fails. Documented the deferral in the baseline file. Baseline measurements taken against the non-prerendered production build for future regression comparisons. * style(docs): tighten typography scale and body rhythm Smaller h1/h2/h3 (1.875/1.25/1.0625 rem) and body line-height 1.6 match the 'dense but scannable' principle in CLAUDE.md and bring the docs closer to Linear/Raycast density without sacrificing readability. * docs(plan): mark docs revamp validation checklist and note follow-ups Code-level items verified, visual items flagged for human check. Honest on the LCP number: 7.8s under Lighthouse mobile throttling does not meet the 1.5s target, though TBT is 0ms and server latency is ~20ms so perceived perf is far better than the mobile score. Broken-internal-links check dropped from Phase 2 — noted as follow-up. * fix(docs): scope prose link color so landing hero CTA is readable The global \`a { color: var(--dp-accent) }\` rule was leaking into \`routes/index.tsx\` and overriding the landing page CTA's inline \`text-[#0a0a0b]\` class. Because the CTA background is also var(--dp-accent), the button text was invisible-on-itself. Scope the rule to \`article a\` so it only styles MDX prose content (docs pages wrap in <article> via DocsPage; landing uses <main> via HomeLayout). Sidebar, TOC, and navbar links already have their own scoped rules and are unaffected. This bug was pre-existing (introduced in04268973, 2025-11-30) but surfaced during the docs revamp visual review. * fix(docs): resolve type checking errors and commit routeTree.gen.ts
13 lines
315 B
TypeScript
13 lines
315 B
TypeScript
import { defineConfig, defineDocs } from 'fumadocs-mdx/config'
|
|
import remarkGfm from 'remark-gfm'
|
|
import remarkSmartypants from 'remark-smartypants'
|
|
|
|
export const docs = defineDocs({
|
|
dir: 'content/docs',
|
|
})
|
|
|
|
export default defineConfig({
|
|
mdxOptions: {
|
|
remarkPlugins: [remarkGfm, remarkSmartypants],
|
|
},
|
|
})
|