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 Image -> combine with img or ImageZoom
      • Port FileTree -> map onto existing components
      • Port Icon: this should include fontawesome icons port too
      • Port Cards
      • Port other Mintlify components in use (<[A-Z])
        • Stubs for all previously used ones
      • When porting per-page custom components, adjust their styles
    • Frontmatter updates
      • wide pages → switched to using the built-in full prop
      • openapi pages: contents, generation, sidebar placement
      • noindex support
      • url support
      • sidebarTitle support
    • Use Inter font
    • Use brand colors, use TON logo
    • Add some enhancements made in ton-blockchain/acton
    • Add some enhancements made in the-ton-tech/ton-docs-private
      • Redirects for all new routes of the-ton-tech/ton-docs-private
    • Fix issues with styles on selected pages, especially with per-page components.
    • 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
  • Build caching: https://nextjs.org/docs/pages/guides/ci-build-caching#github-actions

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.

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