From 95f072c0c12053ac078b995b07d13a73d92c9101 Mon Sep 17 00:00:00 2001 From: "mintlify[bot]" <109931778+mintlify[bot]@users.noreply.github.com> Date: Wed, 9 Sep 2026 22:07:49 +0000 Subject: [PATCH 1/3] docs: document the editor comments panel with open and resolved lists --- editor/collaborate.mdx | 4 +++- es/editor/collaborate.mdx | 4 +++- fr/editor/collaborate.mdx | 4 +++- zh/editor/collaborate.mdx | 4 +++- 4 files changed, 12 insertions(+), 4 deletions(-) diff --git a/editor/collaborate.mdx b/editor/collaborate.mdx index cc50e21cc..3c67cb85a 100644 --- a/editor/collaborate.mdx +++ b/editor/collaborate.mdx @@ -20,9 +20,11 @@ To add a comment, highlight text and click the +To see every thread on the current page, click **More options** in the top-right of the page, then click **Comments**. The panel lists the page's comments and suggestions in **Open** and **Resolved** lists, with a count for each. From the panel you can reply, react, and resolve or reopen threads. The panel stays open as you switch pages and updates to show the current page's threads. + React to a comment to acknowledge it without replying. Hover over a comment, click the **Add reaction** button, and choose an emoji. Search the picker to find a specific emoji. Click an existing reaction to add or remove yours. Hover over a reaction to see who reacted. Reacting to someone else's comment notifies the comment's author. -All [roles](/dashboard/roles) can comment and reply, including viewers. Only editors and admins can resolve threads. Resolving a thread removes it from the sidebar and clears the highlight from the page. +All [roles](/dashboard/roles) can comment and reply, including viewers. Only editors and admins can resolve threads. Resolving a thread removes it from the sidebar and clears the highlight from the page. Resolved threads stay available in the **Resolved** list of the comments panel. You can delete your own comments and admins can delete any comment. Deleting the first comment in a thread deletes the entire thread. diff --git a/es/editor/collaborate.mdx b/es/editor/collaborate.mdx index f5b019789..c8f8141b7 100644 --- a/es/editor/collaborate.mdx +++ b/es/editor/collaborate.mdx @@ -24,9 +24,11 @@ Para añadir un comentario, resalte un texto y haga clic en el icono +Para ver todos los hilos de la página actual, haga clic en **More options** en la esquina superior derecha de la página y luego en **Comments**. El panel muestra los comentarios y sugerencias de la página en las listas **Open** y **Resolved**, con un contador para cada una. Desde el panel puede responder, reaccionar y resolver o reabrir hilos. El panel permanece abierto al cambiar de página y se actualiza para mostrar los hilos de la página actual. + Reaccione a un comentario para darse por enterado sin responder. Pase el cursor sobre un comentario, haga clic en el botón **Add reaction** y elija un emoji. Busque en el selector para encontrar un emoji concreto. Haga clic en una reacción existente para añadir o quitar la suya. Pase el cursor sobre una reacción para ver quién reaccionó. Reaccionar al comentario de otra persona envía una notificación al autor del comentario. -Todos los [roles](/es/dashboard/roles) pueden comentar y responder, incluidos los viewers. Solo los editors y admins pueden resolver hilos. Resolver un hilo lo quita de la barra lateral y elimina el resaltado de la página. +Todos los [roles](/es/dashboard/roles) pueden comentar y responder, incluidos los viewers. Solo los editors y admins pueden resolver hilos. Resolver un hilo lo quita de la barra lateral y elimina el resaltado de la página. Los hilos resueltos siguen disponibles en la lista **Resolved** del panel de comentarios. Puede eliminar sus propios comentarios y los admins pueden eliminar cualquier comentario. Eliminar el primer comentario de un hilo elimina el hilo completo. diff --git a/fr/editor/collaborate.mdx b/fr/editor/collaborate.mdx index a0a655494..4a1773d4e 100644 --- a/fr/editor/collaborate.mdx +++ b/fr/editor/collaborate.mdx @@ -24,9 +24,11 @@ Pour ajouter un commentaire, surlignez du texte et cliquez sur l'icône +Pour voir tous les fils de la page actuelle, cliquez sur **More options** en haut à droite de la page, puis sur **Comments**. Le panneau affiche les commentaires et suggestions de la page dans les listes **Open** et **Resolved**, avec un compteur pour chacune. Depuis le panneau, vous pouvez répondre, réagir et résoudre ou rouvrir des fils. Le panneau reste ouvert lorsque vous changez de page et se met à jour pour afficher les fils de la page actuelle. + Réagissez à un commentaire pour en prendre acte sans répondre. Survolez un commentaire, cliquez sur le bouton **Add reaction**, puis choisissez un emoji. Faites une recherche dans le sélecteur pour trouver un emoji précis. Cliquez sur une réaction existante pour ajouter ou retirer la vôtre. Survolez une réaction pour voir qui a réagi. Réagir au commentaire d'une autre personne envoie une notification à l'auteur du commentaire. -Tous les [rôles](/fr/dashboard/roles) peuvent commenter et répondre, y compris les viewers. Seuls les editors et les admins peuvent résoudre les fils. Résoudre un fil le retire de la barre latérale et supprime le surlignage de la page. +Tous les [rôles](/fr/dashboard/roles) peuvent commenter et répondre, y compris les viewers. Seuls les editors et les admins peuvent résoudre les fils. Résoudre un fil le retire de la barre latérale et supprime le surlignage de la page. Les fils résolus restent disponibles dans la liste **Resolved** du panneau de commentaires. Vous pouvez supprimer vos propres commentaires et les admins peuvent supprimer n'importe quel commentaire. Supprimer le premier commentaire d'un fil supprime le fil entier. diff --git a/zh/editor/collaborate.mdx b/zh/editor/collaborate.mdx index 7c3ddf1e3..666f842c1 100644 --- a/zh/editor/collaborate.mdx +++ b/zh/editor/collaborate.mdx @@ -24,9 +24,11 @@ keywords: ["comments", "suggestions", "collaboration", "review", "mentions", "re 编辑器中所选文本上方浮动工具栏里的评论按钮。 +要查看当前页面的所有线程，请点击页面右上角的 **More options**，然后点击 **Comments**。面板会以 **Open** 和 **Resolved** 两个列表显示该页面的评论和建议，并分别显示数量。你可以在面板中回复、添加回应，以及解决或重新打开线程。切换页面时面板保持打开，并更新为当前页面的线程。 + 对评论添加回应，无需回复即可表示已读。将鼠标悬停在评论上，点击 **Add reaction** 按钮，然后选择一个表情符号。在选择器中搜索可以找到特定的表情符号。点击已有的回应可以添加或移除你自己的回应。将鼠标悬停在回应上可以查看是谁做出的回应。对他人的评论做出回应时，会通知该评论的作者。 -所有[角色](/zh/dashboard/roles)都可以发表评论和回复，包括 viewers。只有 editors 和 admins 可以解决线程。解决线程会把它从侧边栏中移除，并清除页面上的高亮。 +所有[角色](/zh/dashboard/roles)都可以发表评论和回复，包括 viewers。只有 editors 和 admins 可以解决线程。解决线程会把它从侧边栏中移除，并清除页面上的高亮。已解决的线程仍可在评论面板的 **Resolved** 列表中查看。 你可以删除自己的评论，admins 可以删除任何评论。删除线程中的第一条评论会删除整个线程。 From a28682190f56c3261914d742aabda0a0c87355af Mon Sep 17 00:00:00 2001 From: "mintlify[bot]" <109931778+mintlify[bot]@users.noreply.github.com> Date: Wed, 9 Sep 2026 22:41:45 +0000 Subject: [PATCH 2/3] Updated mintlify pages - Updated quickstart.mdx Mintlify-Source: dashboard-editor --- quickstart.mdx | 219 ++----------------------------------------------- 1 file changed, 9 insertions(+), 210 deletions(-) diff --git a/quickstart.mdx b/quickstart.mdx index b5c323098..87cd70d50 100644 --- a/quickstart.mdx +++ b/quickstart.mdx @@ -1,214 +1,13 @@ --- title: "Quickstart" -description: "Get started with Mintlify by deploying your documentation site in minutes and making your first content change with the web editor or Git." -keywords: ["quickstart", "deploy", "get started", "first steps", "tutorial", "setup", "onboarding"] +description: "Get started with Mintlify by deploying your documentation site in minutes and making your first content change with the web editor or Git" +keywords: + - "quickstart" + - "deploy" + - "get started" + - "first steps" + - "tutorial" + - "setup" + - "onboarding" boost: 3 --- - -import SetupAgentPrompt from "/snippets/setup-agent-prompt.mdx"; - -After you complete this guide, you'll have a live documentation site ready to customize and update. - - - - Using an AI agent? - - Copy the following prompt to have your agent set up your site for you. It directs your agent to create your account and deploy your site. It also adds the Mintlify [skill](/ai/skillmd) and [Model Context Protocol (MCP) server](/ai/model-context-protocol) for better results when you update your content. - - The prompt splits the quickstart into tasks your agent can complete and directs it to ask you for any information it needs while getting everything set up. - - - - - -{/* vale Mintlify.OxfordComma = NO */} - - ## Set up Mintlify for the user - - If the user asks you to set up Mintlify, a documentation site, or a local Mintlify project, complete the following workflow yourself. Ask the user only for information or approvals you cannot supply. Do not send the user to the browser-first quickstart unless you cannot run terminal commands. - - 1. Run `node --version` and confirm it reports Node.js v20.17.0 or newer, preferring an LTS release. - 2. Run `mint --version`. If the command is unavailable, install the CLI with `npm i -g mint` or `pnpm add -g mint`. If the command succeeds, run `mint update`. - 3. Run `mint status` before starting authentication. If it already shows an organization, keep the existing session and do not create another account. - 4. Run `mint login` if the user has an account. Otherwise, ask for their first name, last name, company, and email, then run: - - ```bash - mint signup \ - --firstName \ - --lastName \ - --company \ - --email - ``` - - `mint signup` waits for email verification, so keep it running as a background process when your environment supports background commands. Tell the user to click the verification link and approve the CLI in the browser. Never invent signup details. - 5. After the user finishes verification and onboarding, run `mint status` again. Confirm that it reports their email, organization, and subdomain. If the organization exists but no subdomain appears, ask the user to finish selecting or connecting a GitHub repository in the onboarding browser tab, then retry. - 6. If the user has an existing documentation repository, clone or open it. Preserve its content. For a new local project, scaffold into a new, empty directory with either `mint new --name --theme ` or `mint new --template `. Ask which theme or template they want if they have not specified one. Do not use `--force` on a directory containing user files. - 7. Run `mint dev --no-open` from the directory containing `docs.json` as a background process. Confirm the local URL loads, report it to the user, and stop the process when it is no longer needed. - 8. Run `mint validate` and `mint broken-links`. Fix issues caused by your changes before continuing. - 9. If a Git repository backs the project and the user asked for deployment, commit and push the changes. A push to the production branch triggers a deployment. Do not overwrite an existing repository with starter content. - 10. Run `mint status` to get the configured subdomain, then verify that `https://.mintlify.site` loads before reporting that deployment is complete. - - Have the user complete browser actions only for email verification, OAuth approval, and connecting or authorizing GitHub. Keep ownership of the terminal workflow and resume after each user action. For command flags and troubleshooting, use the [CLI command reference](/cli/commands). - -{/* vale Mintlify.OxfordComma = YES */} - -## Before you begin - -Mintlify uses a docs-as-code approach to manage your documentation. Every page on your site has a corresponding file stored in your documentation repository. - -When you connect your documentation repository to your project, you can work on your documentation locally or in the web editor and sync any changes to your remote repository. - -## Deploy your documentation site - - - Go to [mintlify.com/start](https://mintlify.com/start) and complete the onboarding process. During onboarding, you name your site and answer a few questions about how you plan to use it. You can also connect your GitHub account and install the GitHub App to enable automatic deployments. - - In the final onboarding step, describe the docs that you want to build. You can add links to your existing site, upload files, or select GitHub repositories to use as sources. The Mintlify agent generates a starting point for your docs while you watch a live preview. Answer any questions the agent asks to refine the result. To start with placeholder content instead, select **Skip, start from a blank template**. - - After onboarding, your documentation site deploys and is accessible at your `.mintlify.site` URL. - - - If you want to get started quickly without connecting your own repository, you can skip the Git provider connection during onboarding. Mintlify creates a private repository in a private organization and automatically configures the GitHub App for you. - - This lets you use the web editor immediately. If you want to use your own repository later, go to [Git Settings](https://app.mintlify.com/settings/deployment/git-settings) in your dashboard to migrate your content using the Git setup wizard. See [Clone to your own repository](/deploy/github#clone-to-your-own-repository) for details. - - - - - Use the preceding CLI setup workflow. Initiate the corresponding `mint signup` or `mint login` command. Account verification and GitHub authorization open browser pages; have the user approve them. Continue the setup when they finish. Do not consider setup complete until `mint status` reports a subdomain and the deployed `.mintlify.site` URL loads. - - -## View your deployed site - -Your documentation site is now deployed at `https://.mintlify.site`. - -Find your exact URL on the **Overview** page of your [dashboard](https://app.mintlify.com/). - - - Overview page of the Mintlify dashboard. - Overview page of the Mintlify dashboard. - - - - Your site is ready to view immediately. Use this URL for testing and sharing with your team. Before sharing with your users, you may want to add a [custom domain](/customize/custom-domain). - - -## Make your first change - - - - - - The CLI requires [Node.js](https://nodejs.org/en) v20.17.0 or higher. Use an LTS version for stability. - - - - ```bash npm - npm i -g mint - ``` - - ```bash pnpm - pnpm add -g mint - ``` - - - - See [Install the CLI](/cli/install) for full details and troubleshooting. - - - If you haven't already cloned your repository locally, clone it using Git: - - ```bash - git clone - ``` - - If your repository is in Mintlify's private organization, see [Clone to your own repository](/deploy/github#clone-to-your-own-repository) to move it to your account first. - - - Open `index.mdx` in your preferred editor and update the description in the frontmatter: - - ```mdx - --- - title: "Introduction" - description: "Your custom description here" - --- - ``` - - - Run the following command from your documentation directory: - - ```bash - mint dev - ``` - - View your preview at `http://localhost:3000`. - - - Commit and push your changes to trigger a deployment: - - ```bash - git add . - git commit -m "Update description" - git push - ``` - - Mintlify automatically deploys your changes. View your deployment status on the [Overview](https://app.mintlify.com/) page of your dashboard. - - - - - - - Navigate to the [web editor](https://app.mintlify.com/editor) in your dashboard. - - - Open the **Introduction** page and update the description. - - - Introduction page open in the web editor with the description edited to say Hello world!. - Introduction page open in the web editor with the description edited to say Hello world!. - - - - Click **Publish** in the top-right of the web editor toolbar. - - - On the [Overview](https://app.mintlify.com/) page of your dashboard, you can see your site's deployment status. When it finishes deploying, refresh your documentation site to see your changes live. - - - - - -## Next steps - - - Edit documentation in your browser and preview how your pages look when published. - - - - Connect AI tools like Claude, Cursor, and ChatGPT to your search MCP server so they can efficiently search and retrieve content from your site. - - - - Find broken links, check accessibility, validate OpenAPI specs, and more. - - - - Use your own domain for your documentation site. - From 932212a28090741e68eb475d54166cb7f3a0e974 Mon Sep 17 00:00:00 2001 From: "mintlify[bot]" <109931778+mintlify[bot]@users.noreply.github.com> Date: Thu, 10 Sep 2026 05:48:44 +0000 Subject: [PATCH 3/3] docs: note source mode comment thread support and restore quickstart --- editor/collaborate.mdx | 2 + es/editor/collaborate.mdx | 2 + fr/editor/collaborate.mdx | 2 + quickstart.mdx | 219 ++++++++++++++++++++++++++++++++++++-- zh/editor/collaborate.mdx | 2 + 5 files changed, 218 insertions(+), 9 deletions(-) diff --git a/editor/collaborate.mdx b/editor/collaborate.mdx index 3c67cb85a..db17c7665 100644 --- a/editor/collaborate.mdx +++ b/editor/collaborate.mdx @@ -20,6 +20,8 @@ To add a comment, highlight text and click the +Comment threads appear in both visual and source mode. In source mode, you can read, reply to, and resolve existing threads, but starting a new comment requires visual mode. + To see every thread on the current page, click **More options** in the top-right of the page, then click **Comments**. The panel lists the page's comments and suggestions in **Open** and **Resolved** lists, with a count for each. From the panel you can reply, react, and resolve or reopen threads. The panel stays open as you switch pages and updates to show the current page's threads. React to a comment to acknowledge it without replying. Hover over a comment, click the **Add reaction** button, and choose an emoji. Search the picker to find a specific emoji. Click an existing reaction to add or remove yours. Hover over a reaction to see who reacted. Reacting to someone else's comment notifies the comment's author. diff --git a/es/editor/collaborate.mdx b/es/editor/collaborate.mdx index c8f8141b7..219576c13 100644 --- a/es/editor/collaborate.mdx +++ b/es/editor/collaborate.mdx @@ -24,6 +24,8 @@ Para añadir un comentario, resalte un texto y haga clic en el icono +Los hilos de comentarios aparecen tanto en el modo visual como en el modo source. En el modo source puede leer, responder y resolver hilos existentes, pero iniciar un comentario nuevo requiere el modo visual. + Para ver todos los hilos de la página actual, haga clic en **More options** en la esquina superior derecha de la página y luego en **Comments**. El panel muestra los comentarios y sugerencias de la página en las listas **Open** y **Resolved**, con un contador para cada una. Desde el panel puede responder, reaccionar y resolver o reabrir hilos. El panel permanece abierto al cambiar de página y se actualiza para mostrar los hilos de la página actual. Reaccione a un comentario para darse por enterado sin responder. Pase el cursor sobre un comentario, haga clic en el botón **Add reaction** y elija un emoji. Busque en el selector para encontrar un emoji concreto. Haga clic en una reacción existente para añadir o quitar la suya. Pase el cursor sobre una reacción para ver quién reaccionó. Reaccionar al comentario de otra persona envía una notificación al autor del comentario. diff --git a/fr/editor/collaborate.mdx b/fr/editor/collaborate.mdx index 4a1773d4e..314a1723d 100644 --- a/fr/editor/collaborate.mdx +++ b/fr/editor/collaborate.mdx @@ -24,6 +24,8 @@ Pour ajouter un commentaire, surlignez du texte et cliquez sur l'icône +Les fils de commentaires apparaissent en mode visuel comme en mode source. En mode source, vous pouvez lire les fils existants, y répondre et les résoudre, mais créer un nouveau commentaire nécessite le mode visuel. + Pour voir tous les fils de la page actuelle, cliquez sur **More options** en haut à droite de la page, puis sur **Comments**. Le panneau affiche les commentaires et suggestions de la page dans les listes **Open** et **Resolved**, avec un compteur pour chacune. Depuis le panneau, vous pouvez répondre, réagir et résoudre ou rouvrir des fils. Le panneau reste ouvert lorsque vous changez de page et se met à jour pour afficher les fils de la page actuelle. Réagissez à un commentaire pour en prendre acte sans répondre. Survolez un commentaire, cliquez sur le bouton **Add reaction**, puis choisissez un emoji. Faites une recherche dans le sélecteur pour trouver un emoji précis. Cliquez sur une réaction existante pour ajouter ou retirer la vôtre. Survolez une réaction pour voir qui a réagi. Réagir au commentaire d'une autre personne envoie une notification à l'auteur du commentaire. diff --git a/quickstart.mdx b/quickstart.mdx index 87cd70d50..b5c323098 100644 --- a/quickstart.mdx +++ b/quickstart.mdx @@ -1,13 +1,214 @@ --- title: "Quickstart" -description: "Get started with Mintlify by deploying your documentation site in minutes and making your first content change with the web editor or Git" -keywords: - - "quickstart" - - "deploy" - - "get started" - - "first steps" - - "tutorial" - - "setup" - - "onboarding" +description: "Get started with Mintlify by deploying your documentation site in minutes and making your first content change with the web editor or Git." +keywords: ["quickstart", "deploy", "get started", "first steps", "tutorial", "setup", "onboarding"] boost: 3 --- + +import SetupAgentPrompt from "/snippets/setup-agent-prompt.mdx"; + +After you complete this guide, you'll have a live documentation site ready to customize and update. + + + + Using an AI agent? + + Copy the following prompt to have your agent set up your site for you. It directs your agent to create your account and deploy your site. It also adds the Mintlify [skill](/ai/skillmd) and [Model Context Protocol (MCP) server](/ai/model-context-protocol) for better results when you update your content. + + The prompt splits the quickstart into tasks your agent can complete and directs it to ask you for any information it needs while getting everything set up. + + + + + +{/* vale Mintlify.OxfordComma = NO */} + + ## Set up Mintlify for the user + + If the user asks you to set up Mintlify, a documentation site, or a local Mintlify project, complete the following workflow yourself. Ask the user only for information or approvals you cannot supply. Do not send the user to the browser-first quickstart unless you cannot run terminal commands. + + 1. Run `node --version` and confirm it reports Node.js v20.17.0 or newer, preferring an LTS release. + 2. Run `mint --version`. If the command is unavailable, install the CLI with `npm i -g mint` or `pnpm add -g mint`. If the command succeeds, run `mint update`. + 3. Run `mint status` before starting authentication. If it already shows an organization, keep the existing session and do not create another account. + 4. Run `mint login` if the user has an account. Otherwise, ask for their first name, last name, company, and email, then run: + + ```bash + mint signup \ + --firstName \ + --lastName \ + --company \ + --email + ``` + + `mint signup` waits for email verification, so keep it running as a background process when your environment supports background commands. Tell the user to click the verification link and approve the CLI in the browser. Never invent signup details. + 5. After the user finishes verification and onboarding, run `mint status` again. Confirm that it reports their email, organization, and subdomain. If the organization exists but no subdomain appears, ask the user to finish selecting or connecting a GitHub repository in the onboarding browser tab, then retry. + 6. If the user has an existing documentation repository, clone or open it. Preserve its content. For a new local project, scaffold into a new, empty directory with either `mint new --name --theme ` or `mint new --template `. Ask which theme or template they want if they have not specified one. Do not use `--force` on a directory containing user files. + 7. Run `mint dev --no-open` from the directory containing `docs.json` as a background process. Confirm the local URL loads, report it to the user, and stop the process when it is no longer needed. + 8. Run `mint validate` and `mint broken-links`. Fix issues caused by your changes before continuing. + 9. If a Git repository backs the project and the user asked for deployment, commit and push the changes. A push to the production branch triggers a deployment. Do not overwrite an existing repository with starter content. + 10. Run `mint status` to get the configured subdomain, then verify that `https://.mintlify.site` loads before reporting that deployment is complete. + + Have the user complete browser actions only for email verification, OAuth approval, and connecting or authorizing GitHub. Keep ownership of the terminal workflow and resume after each user action. For command flags and troubleshooting, use the [CLI command reference](/cli/commands). + +{/* vale Mintlify.OxfordComma = YES */} + +## Before you begin + +Mintlify uses a docs-as-code approach to manage your documentation. Every page on your site has a corresponding file stored in your documentation repository. + +When you connect your documentation repository to your project, you can work on your documentation locally or in the web editor and sync any changes to your remote repository. + +## Deploy your documentation site + + + Go to [mintlify.com/start](https://mintlify.com/start) and complete the onboarding process. During onboarding, you name your site and answer a few questions about how you plan to use it. You can also connect your GitHub account and install the GitHub App to enable automatic deployments. + + In the final onboarding step, describe the docs that you want to build. You can add links to your existing site, upload files, or select GitHub repositories to use as sources. The Mintlify agent generates a starting point for your docs while you watch a live preview. Answer any questions the agent asks to refine the result. To start with placeholder content instead, select **Skip, start from a blank template**. + + After onboarding, your documentation site deploys and is accessible at your `.mintlify.site` URL. + + + If you want to get started quickly without connecting your own repository, you can skip the Git provider connection during onboarding. Mintlify creates a private repository in a private organization and automatically configures the GitHub App for you. + + This lets you use the web editor immediately. If you want to use your own repository later, go to [Git Settings](https://app.mintlify.com/settings/deployment/git-settings) in your dashboard to migrate your content using the Git setup wizard. See [Clone to your own repository](/deploy/github#clone-to-your-own-repository) for details. + + + + + Use the preceding CLI setup workflow. Initiate the corresponding `mint signup` or `mint login` command. Account verification and GitHub authorization open browser pages; have the user approve them. Continue the setup when they finish. Do not consider setup complete until `mint status` reports a subdomain and the deployed `.mintlify.site` URL loads. + + +## View your deployed site + +Your documentation site is now deployed at `https://.mintlify.site`. + +Find your exact URL on the **Overview** page of your [dashboard](https://app.mintlify.com/). + + + Overview page of the Mintlify dashboard. + Overview page of the Mintlify dashboard. + + + + Your site is ready to view immediately. Use this URL for testing and sharing with your team. Before sharing with your users, you may want to add a [custom domain](/customize/custom-domain). + + +## Make your first change + + + + + + The CLI requires [Node.js](https://nodejs.org/en) v20.17.0 or higher. Use an LTS version for stability. + + + + ```bash npm + npm i -g mint + ``` + + ```bash pnpm + pnpm add -g mint + ``` + + + + See [Install the CLI](/cli/install) for full details and troubleshooting. + + + If you haven't already cloned your repository locally, clone it using Git: + + ```bash + git clone + ``` + + If your repository is in Mintlify's private organization, see [Clone to your own repository](/deploy/github#clone-to-your-own-repository) to move it to your account first. + + + Open `index.mdx` in your preferred editor and update the description in the frontmatter: + + ```mdx + --- + title: "Introduction" + description: "Your custom description here" + --- + ``` + + + Run the following command from your documentation directory: + + ```bash + mint dev + ``` + + View your preview at `http://localhost:3000`. + + + Commit and push your changes to trigger a deployment: + + ```bash + git add . + git commit -m "Update description" + git push + ``` + + Mintlify automatically deploys your changes. View your deployment status on the [Overview](https://app.mintlify.com/) page of your dashboard. + + + + + + + Navigate to the [web editor](https://app.mintlify.com/editor) in your dashboard. + + + Open the **Introduction** page and update the description. + + + Introduction page open in the web editor with the description edited to say Hello world!. + Introduction page open in the web editor with the description edited to say Hello world!. + + + + Click **Publish** in the top-right of the web editor toolbar. + + + On the [Overview](https://app.mintlify.com/) page of your dashboard, you can see your site's deployment status. When it finishes deploying, refresh your documentation site to see your changes live. + + + + + +## Next steps + + + Edit documentation in your browser and preview how your pages look when published. + + + + Connect AI tools like Claude, Cursor, and ChatGPT to your search MCP server so they can efficiently search and retrieve content from your site. + + + + Find broken links, check accessibility, validate OpenAPI specs, and more. + + + + Use your own domain for your documentation site. + diff --git a/zh/editor/collaborate.mdx b/zh/editor/collaborate.mdx index 666f842c1..61c407eea 100644 --- a/zh/editor/collaborate.mdx +++ b/zh/editor/collaborate.mdx @@ -24,6 +24,8 @@ keywords: ["comments", "suggestions", "collaboration", "review", "mentions", "re 编辑器中所选文本上方浮动工具栏里的评论按钮。 +评论线程在可视化模式和 source 模式中都会显示。在 source 模式中，你可以查看、回复和解决现有线程，但新建评论需要使用可视化模式。 + 要查看当前页面的所有线程，请点击页面右上角的 **More options**，然后点击 **Comments**。面板会以 **Open** 和 **Resolved** 两个列表显示该页面的评论和建议，并分别显示数量。你可以在面板中回复、添加回应，以及解决或重新打开线程。切换页面时面板保持打开，并更新为当前页面的线程。 对评论添加回应，无需回复即可表示已读。将鼠标悬停在评论上，点击 **Add reaction** 按钮，然后选择一个表情符号。在选择器中搜索可以找到特定的表情符号。点击已有的回应可以添加或移除你自己的回应。将鼠标悬停在回应上可以查看是谁做出的回应。对他人的评论做出回应时，会通知该评论的作者。