Skip to content

Migration to Fumadocs #2192

@novusnota

Description

@novusnota

The rough plan:

  • Gradually move all pages
    • Add required components
      • Port Aside -> replace with Callouts or have a mapping
      • Port FileTree -> map onto existing components
      • Port Image -> combine with img or ImageZoom
      • Port Cards
      • Port other Mintlify components in use (<[A-Z])
        • Stubs for all previously used ones
      • Edit contribute/ pages and overviews
      • Adjust CodeGroups and enhance code blocks:
        • Requires an Icon port: this might (?) include fontawesome icons set too, as an alternative
        • title alias for tab
        • an icon prop for tabs (via Icon)
      • Fix issues with styles on selected pages, especially with per-page components: TVM instructions, Catchain visualizer
    • Frontmatter updates
      • wide pages → switched to using the built-in full prop
      • openapi pages: contents, generation, sidebar placement
      • noindex support
      • url support
      • sidebarTitle support
      • tag support
    • Use Inter font
    • Use brand colors, use TON logo
    • meta.json with previous structure
  • Gradually move prior top-level setup
    • resourcespublic
    • scripts → fix pathing wrt new content/ folder
    • snippets (what's left of them after the previous step)
    • .github/ → stay as is
  • Replace top-level contents with Fumadocs, gradually deprecate mint involvement
  • Update the MCP and AI pages: temporary removal of an assistant, permanent removal of a MCP server for the docs in favor of llms.txt plus skill files.
  • Set up build caching: https://nextjs.org/docs/pages/guides/ci-build-caching#github-actions

Notes:

  • Stronger structural changes and enhancements should be done afterward as they are too tricky to work on in parallel. Unfinished and unpolished structural changes shall not be published to end-users as that would break their workflows.
  • Redirects will follow suit: Move the redirects from docs.json over to vercel.json #2211.
  • Add some enhancements made in ton-blockchain/acton
  • Add some enhancements made in the-ton-tech/ton-docs-private

Process:

Metadata

Metadata

Assignees

Labels

prio: highASAP, deadline due yesterdaysize: bigThis is a hard task, more like a project and will take a while to implement

Type

No fields configured for Task.

Projects

No projects

Relationships

None yet

Development

No branches or pull requests

Issue actions