Skip to content

Proposal: Adopt the Fumadocs-Powered Documentation Site #2552

@jerikchan

Description

@jerikchan

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

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

  1. Review the preview to confirm the navigation, styling, and content blocks meet expectations.
  2. 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.
  3. Merge the Fumadocs scaffolding into the official repo and customize the theme tokens to match Walrus brand guidelines.
  4. 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.

Metadata

Metadata

Assignees

No one assigned

    Labels

    documentationImprovements or additions to documentation

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions