-
Notifications
You must be signed in to change notification settings - Fork 104
Open
Labels
documentationImprovements or additions to documentationImprovements or additions to documentation
Description
Description
Summary
I’ve built a Walrus documentation site on top of Next.js and Fumadocs to explore a more modern docs experience. The goal is to keep the content structure you
already have, but deliver it with faster navigation, better search, and a polished UI that feels consistent with Walrus branding.
Preview & Source
- Deployed preview: https://walrus-fumadocs.vercel.app/
- Source repository: https://github.com/jerikchan/walrus-fumadocs
Highlights
- Fumadocs-powered sidebar, breadcrumbs, and content layout with built-in dark mode.
- MDX content pipeline for richer examples, callouts, and component embeds without extra tooling.
- Algolia-ready search integration; currently using the default Fumadocs search but can be wired to your preferred provider.
- Responsive design and optimized asset loading for a better mobile experience.
Suggested Adoption Path
- Review the preview to confirm the navigation, styling, and content blocks meet expectations.
- Decide whether to port existing docs markdown directly or connect to your current CMS/static source; Fumadocs supports both file-based and remote content
loaders. - Merge the Fumadocs scaffolding into the official repo and customize the theme tokens to match Walrus brand guidelines.
- Set up deployment (Vercel is pre-configured) and hook into your domain for production rollout.
Questions / Feedback
- Are there specific components or integrations you’d like the docs to showcase (e.g., live API explorer, SDK snippets)?
- Any requirements around localization or versioned docs that I should plan for next?
Happy to iterate on the prototype or help with the integration if you decide to move forward.
Code of Conduct
- I agree to follow this project's Code of Conduct.
Reactions are currently unavailable
Metadata
Metadata
Assignees
Labels
documentationImprovements or additions to documentationImprovements or additions to documentation