diff --git a/index.mdx b/index.mdx index d6cdc7adc..5a199c283 100644 --- a/index.mdx +++ b/index.mdx @@ -1,75 +1,130 @@ --- -title: "Introduction" +title: "Documentation" +sidebarTitle: "Introduction" description: "Meet the next generation of documentation. AI-native, beautiful out-of-the-box, and built for developers." mode: "frame" keywords: ["overview", "platform", "getting started", "features"] --- -export const HeroCard = ({ filename, title, description, href }) => { +export const HeroCard = ({ filename, title, children }) => { return ( - - - -

+
+
+ + +
+

{title} -

- {description} -
+

+ +
+ {children} +
+ ); }; -
-
- Decorative background image. - Decorative background image. -
-
-

- Documentation -

+import { AccordionRow, AccordionRowItem } from '/snippets/accordion-row.mdx'; -
- Meet the next generation of documentation. AI-native, beautiful out-of-the-box, and built for developers and teams. +
+
+
+ Decorative background image. + Decorative background image. +
+
+

+ Documentation +

+

+ Meet the next generation of documentation. AI-native, beautiful out-of-the-box, and built for developers. +

+
+ +
+ + + 1. Follow the [quickstart](/quickstart) to deploy your documentation site. + 2. Set a [custom domain](/customize/custom-domain). + 3. Configure [global settings](/settings). + + + 1. Follow the [quickstart](/quickstart) to deploy your documentation site. + 2. Add your [OpenAPI specification](/api-playground/openapi-setup). + 3. Set a [custom domain](/customize/custom-domain). + + + 1. Follow the [migration guide](/migration) to move your documentation to Mintlify. + 2. Read the [quickstart](/quickstart) to become familiar with the platform. + +
- + + Your documentation automatically [deploys](/deploy/deployments) when you push changes. Share [previews](/deploy/preview-deployments) with your team and act on user [feedback](/insights/feedback). + + title="Collaborate with your entire team" + > + Let your team choose their preferred workflow. Work locally with the [CLI](/installation), in a browser with the [web editor](/editor), or add the [agent](/ai/agent) to your Slack workspace. + + title="Help your users find answers" + > + All sites hosted on Mintlify are optimized for AI tools and search engines out of the box. + + - Set up the [assistant](/ai/assistant) so that users can chat with your documentation. + - Customize your [SEO](/optimize/seo) settings to help search engines find your documentation. + - Add a [contextual menu](/ai/contextual-menu) that lets users quickly query external AI tools, connect to your MCP server, and copy pages as context with one click. + + title="Documentation that stays in sync" + > + - Create a workflow for the [agent to update your documentation](/guides/automate-agent). + - Automatically generate your OpenAPI specification into an interactive [API playground](/api-playground/overview). + - Automatically generate an interactive [API playground](/api-playground/overview) for all your endpoints. +
diff --git a/snippets/accordion-row.mdx b/snippets/accordion-row.mdx new file mode 100644 index 000000000..8a71d7634 --- /dev/null +++ b/snippets/accordion-row.mdx @@ -0,0 +1,65 @@ +export const AccordionRow = ({ children }) => { + return ( + <> + +
+ {children} +
+ + ); +}; + +export const AccordionRowItem = ({ title, children }) => { + return ( +
+ +
+ + {title} + + + + +
+ {children} +
+
+
+ ); +};