Goal

Set up Mintlify to be on par with our current documentation system, enabling us to run a test phase before deciding to fully migrate.

TODO

Content & Sections

• Learn Section
• References Section
• Guides Section
• Remove "Meilisearch documentation" from all MDX title tags

Redirections

• Move redirections.json into docs.json redirection objet

Components

Some components in our current base don't exist on Mintlify or are similar but named differently. We may need to find workarounds to achieve parity on some (e.g., the RouteHighlighter).

• Replace MD images with the Frame component
• NoticeTag
• Capsule
• RouteHighlighter
• ButtonLink

Code Samples

• Parse samples and create components in snippets folder
• Update CI
• IN PROGRESS: Import generated components

Search

• IN PROGRESS: Explore a way to override the default search bar with the meilisearch one

Link Checker

Test the CI and simulate wrong links to see if we have a safety net and the right level of information to fix before publishing something wrong.

Cleaning

• Clean non-needed past workflow
• Ensure meilisearch.com repo is not affecting this one
• Update readme instructions and past documentation for next.js based documentation

Domain setup

• Set-up the domain to be meilisearch.com
• Can we serve it under /docs? https://mintlify.com/docs/advanced/subpath/cloudflare

Other

• Ensure Notum check the parser they've made to generate https://www.meilisearch.com/llms-full.txt is working with our mdx pages and mintlify structure