Skip to content

Polish Devfolio guide to Fumadocs conventions#18

Merged
veesesh merged 6 commits into
mainfrom
polishing
Jun 18, 2026
Merged

Polish Devfolio guide to Fumadocs conventions#18
veesesh merged 6 commits into
mainfrom
polishing

Conversation

@veesesh

@veesesh veesesh commented Jun 18, 2026

Copy link
Copy Markdown
Collaborator

Full pass over the Devfolio guide to align it with Fumadocs authoring conventions, plus a few UI fixes. Bundles the existing mcp-v2-guide-update work since polishing was branched from it.

Content polish (across ~65 guide pages)

  • Headings: removed emoji from all in-page headings (kept emoji on the meta.json sidebar section separators), fixed bold-in-heading and redundant H1s.
  • Videos: replaced repetitive <iframe> embeds with a reusable <Video> component that auto-normalizes YouTube watch/youtu.be URLs to /embed/; local .mp4s now use native <video>.
  • Structure: feature-lists-as-headings → bold labels / <Cards> grids; step sequences → <Steps>; FAQ pages → <Accordions>; blockquote "callouts" → <Callout>.
  • Captions: image/video descriptions now use a centered, muted <Caption> component instead of left-aligned italics.
  • Fixes: corrected invalid Callout types, normalized <p align="center"> caption hacks, wrapped stray <Card> in <Cards>, repaired broken .md relative links, rebuilt a broken image whose alt text contained a step list, removed leftover test.mdx and redundant per-file component imports.

Components / infra

  • Added src/components/video.tsx and src/components/caption.tsx.
  • Registered Tabs, Steps, Accordions, TypeTable, Files, Video, Caption globally in src/mdx-components.tsx.

UI fixes

  • Switched the docs table of contents to the clerk style (tableOfContent={{ style: "clerk" }}).
  • Fixed a large gap above the first content block: the [data-docs-body] wrapper broke prose's first-child margin reset, so pages with a description rendered an oversized gap above the first heading. Reset it so every page starts tight.
  • Removed the "💡 Tip: Use this dropdown…" hint box from the page toolbar.
  • Updated Devfolio MCP guide media and screenshots.

Verification

  • next build passes clean: all 80 docs pages (168 routes incl. llms variants) compile, no MDX errors.

🤖 Generated with Claude Code

veesesh and others added 6 commits June 18, 2026 16:29
- Embed demo video via YouTube embed URL so it renders in iframe
- Refresh MCP setup screenshots
- Add MCP Integration tab screenshot for the hackathon dashboard section
- Remove redundant configure-model-dashboard screenshot

Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
- Remove emoji from all in-page headings (kept on meta.json section separators)
- Add reusable <Video> component (auto-normalizes YouTube embed URLs) and
  register Steps, Accordions, TypeTable, Files, Tabs globally in mdx-components
- Convert video <iframe> embeds to <Video>; local mp4s to native <video>
- Replace heading-as-label feature lists with bold labels / <Cards> grids
- Convert step sequences to <Steps>; FAQ pages to <Accordions>
- Replace blockquote 'callouts' with <Callout>; fix invalid Callout types
- Normalize <p align=center><i> caption hacks to markdown italics
- Wrap stray <Card> in <Cards>; fix broken .md relative links
- Remove leftover test.mdx and redundant per-file component imports
Add a <Caption> component (centered, muted) and use it for the description
text under images/videos across the guide, replacing left-aligned italics.
The MDX wrapper div (data-docs-body) broke prose's first-child margin reset,
so pages with a description rendered a big gap above the first heading. Reset
the first child's top margin so all pages start tight like the MCP page.
Removed the '💡 Tip: Use this dropdown to get help from AI tools like ChatGPT
or Claude.' hint that sat next to the Copy Markdown / Open buttons on every
docs page.
@veesesh
veesesh merged commit 0798f6f into main Jun 18, 2026
4 checks 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