diff --git a/.vale/styles/Google/Acronyms.yml b/.vale/styles/Google/Acronyms.yml index 4c963ca0e..48b830d5b 100644 --- a/.vale/styles/Google/Acronyms.yml +++ b/.vale/styles/Google/Acronyms.yml @@ -31,10 +31,12 @@ exceptions: - HTTPS - IDE - JAR + - JIT - JPEG - JPG - JSON - JSX + - JWT - LESS - LLDB - NET @@ -50,12 +52,14 @@ exceptions: - RAM - REPL - RSA + - SAML - SCM - SCSS - SDK - SQL - SSH - SSL + - SSO - SVG - TBD - TCP diff --git a/.vale/styles/config/vocabularies/Mintlify/accept.txt b/.vale/styles/config/vocabularies/Mintlify/accept.txt index 6bbb6fae5..0dc4b96e7 100644 --- a/.vale/styles/config/vocabularies/Mintlify/accept.txt +++ b/.vale/styles/config/vocabularies/Mintlify/accept.txt @@ -240,7 +240,6 @@ typeof uncached undefined uri -ux val var vars diff --git a/advanced-support.mdx b/advanced-support.mdx index c6635aef1..461cc4464 100644 --- a/advanced-support.mdx +++ b/advanced-support.mdx @@ -6,7 +6,7 @@ keywords: ["support", "CSM", "enterprise"] ## Support options -- All customers receive support via dashboard or support@mintlify.com (24-48 hour response) +- All customers receive support via dashboard or support@mintlify.com (24 hour response) - Enterprise plan customers can add Advanced Slack support (24-hour response) or a dedicated CSM (4-hour response + strategic partnership) ### Standard support (included) diff --git a/agent/index.mdx b/agent/index.mdx index 9b20028fd..13dfb5d5f 100644 --- a/agent/index.mdx +++ b/agent/index.mdx @@ -5,7 +5,7 @@ keywords: ["automation", "automate", "AI", "autoupdate", "maintenance"] --- - The agent is available on [Pro and Enterprise plans](https://mintlify.com/pricing?ref=agent) for anyone with access to your dashboard. + The agent is available on [Enterprise plans](https://mintlify.com/pricing?ref=agent) for anyone with access to your dashboard. The agent creates pull requests with proposed changes to your documentation based on your prompts. When you send a request to the agent, it references your documentation, connected repositories, and Slack messages to create content that follows technical writing best practices and adheres to the Mintlify schema. @@ -28,7 +28,7 @@ Use the agent to: The agent panel open in the dashboard. - **Slack**: Add the agent to your Slack workspace and mention `@mintlify` to prompt it. -- **API**: Embed the agent in custom applications using the [agent endpoints](/api-reference/agent/create-agent-job) +- **API**: Embed the agent in custom applications using the [agent endpoints](/api/agent/create-agent-job). ## Next steps diff --git a/ai-native.mdx b/ai-native.mdx index 1b82ba00c..d2b4a16ce 100644 --- a/ai-native.mdx +++ b/ai-native.mdx @@ -2,7 +2,7 @@ title: "AI-native documentation" sidebarTitle: "AI-native" description: "Learn how AI enhances reading, writing, and discovering your documentation" -keywords: ["AI", "assistant", "agent", "llms.txt", "MCP"] +keywords: ["AI","assistant","agent","llms.txt","MCP","llms-full.txt"] --- When you host your documentation on Mintlify, built-in AI features help your users find answers and your team maintain content more efficiently. Your content provides the context for these AI-native features to improve the experiences of reading, writing, and discovering your documentation. @@ -11,11 +11,11 @@ When you host your documentation on Mintlify, built-in AI features help your use ### Reading -In addition to reading individual pages, users can chat with the [assistant](/ai/assistant) in your documentation for immediate answers to their questions and links to relevant content. The assistant helps guide users through your product with accurate information from your documentation. Embed the assistant into custom apps with the [API](api-reference/assistant/create-assistant-message) to extend where users can access your documentation. +In addition to reading individual pages, users can chat with the [assistant](/ai/assistant) in your documentation for immediate answers to their questions and links to relevant content. The assistant helps guide users through your product with accurate information from your documentation. Embed the assistant into custom apps with the [API](/api/assistant/create-assistant-message) to extend where users can access your documentation. ### Writing -The [agent](/agent) helps you write and maintain documentation. It creates pull requests with proposed changes based on your prompts, pull requests, and Slack threads. Add the agent to your Slack workspace so that anyone on your team can help maintain your documentation by chatting with the agent. Or embed the agent into custom apps via the [API](/api-reference/agent/create-agent-job). +The [agent](/agent) helps you write and maintain documentation. It creates pull requests with proposed changes based on your prompts, pull requests, and Slack threads. Add the agent to your Slack workspace so that anyone on your team can help maintain your documentation by chatting with the agent. Or embed the agent into custom apps via the [API](/api/agent/create-agent-job). You can configure the agent to monitor connected repositories and proactively [suggest](/agent/suggestions) documentation updates when it identifies user-facing changes. @@ -42,10 +42,10 @@ Select any of the following cards for more information. Use the agent in your dashboard to create documentation updates. - + Monitor Git repositories for changes and receive suggested documentation updates. Add a menu to pages that lets users query AI tools, connect to your MCP server, and copy pages as context with one click. - + \ No newline at end of file diff --git a/ai/contextual-menu.mdx b/ai/contextual-menu.mdx index e19e9e0de..e074da343 100644 --- a/ai/contextual-menu.mdx +++ b/ai/contextual-menu.mdx @@ -22,6 +22,7 @@ The contextual menu includes several pre-built options that you can enable by ad | **Open in Perplexity** | `perplexity` | Creates a Perplexity conversation with the current page as context | | **Open in Grok** | `grok` | Creates a Grok conversation with the current page as context | | **Copy MCP server URL** | `mcp` | Copies your MCP server URL to the clipboard | +| **Copy MCP install command** | `add-mcp` | Copies the `npx add-mcp` command to install the MCP server | | **Connect to Cursor** | `cursor` | Installs your hosted MCP server in Cursor | | **Connect to VS Code** | `vscode` | Installs your hosted MCP server in VS Code | | **Custom options** | Object | Add custom options to the contextual menu | diff --git a/ai/model-context-protocol.mdx b/ai/model-context-protocol.mdx index a6b0e3e39..71da1a161 100644 --- a/ai/model-context-protocol.mdx +++ b/ai/model-context-protocol.mdx @@ -30,10 +30,8 @@ The MCP search tool supports optional filtering parameters that AI applications - **`version`**: Filter results to a specific documentation version. For example, `'v0.7'`. Only returns content tagged with the specified version or content available across all versions. - **`language`**: Filter results to a specific language code. For example, `'en'`, `'zh'`, or `'es'`. Only returns content in the specified language or content available across all languages. -- **`apiReferenceOnly`**: When set to `true`, only returns API reference documentation pages. -- **`codeOnly`**: When set to `true`, only returns code snippets and examples. -AI applications determine when to apply these filters based on the context of the user's query. For example, if a user asks about a specific API version or requests code examples, the AI application may automatically apply the appropriate filters to provide more relevant results. +AI applications determine when to apply these filters based on the context of the user's query. For example, if a user asks about a specific API version, the AI application may automatically apply the appropriate filter to provide more relevant results. ### MCP compared to web search @@ -109,6 +107,7 @@ These are some of the ways you can help your users connect to your MCP server: | Option | Identifier | Description | | :----- | :--------- | :---------- | | **Copy MCP server URL** | `mcp` | Copies your MCP server URL to the user's clipboard. | + | **Copy MCP install command** | `add-mcp` | Copies the `npx add-mcp` command to install the MCP server. | | **Connect to Cursor** | `cursor` | Installs your MCP server in Cursor. | | **Connect to VS Code** | `vscode` | Installs your MCP server in VS Code. | diff --git a/ai/skillmd.mdx b/ai/skillmd.mdx index 5784757a7..71fbd91ad 100644 --- a/ai/skillmd.mdx +++ b/ai/skillmd.mdx @@ -4,8 +4,6 @@ description: "Make your docs agent-ready with a structured capability file." keywords: ["AI agents","skills","agent skills","agents"] --- -import { PreviewButton } from "/snippets/previewbutton.jsx" - Mintlify hosts a `skill.md` file at the root of your project that describes what AI agents can do with your product. The [skill.md specification](https://agentskills.io/specification) is a structured, machine-readable format that makes capabilities, required inputs, and constraints for products explicit so that agents can use them more reliably. @@ -32,7 +30,7 @@ View your `skill.md` by appending `/skill.md` to your documentation site's URL. Agents can process your `skill.md` with the [skills CLI](https://www.npmjs.com/package/skills). ```bash -npx skills add your-docs-domain.com +npx skills add https://your-docs-domain.com ``` This adds your product's capabilities to the agent's context so it can take actions on behalf of users. diff --git a/api-playground/overview.mdx b/api-playground/overview.mdx index 2e1ed8077..ed8f89567 100644 --- a/api-playground/overview.mdx +++ b/api-playground/overview.mdx @@ -4,8 +4,6 @@ description: "Let developers test API endpoints directly in your documentation." keywords: ["interactive", "API", "endpoint testing", "live API requests", "request builder"] --- -## Overview - The API playground is an interactive environment that lets users test and explore your API endpoints. Developers can craft API requests, submit them, and view responses without leaving your documentation. See [Trigger an update](/api/update/trigger) for an example of the API playground in action. @@ -103,6 +101,29 @@ Customize your API playground by defining the following properties in your `docs Example languages for the autogenerated API snippets. Languages display in the order specified. + + + | Display name | Key | Aliases | + | --- | --- | --- | + | cURL | `bash` | `curl`, `sh`, `shell` | + | Python | `python` | `py` | + | JavaScript | `javascript` | `js` | + | Node.js | `node` | `nodejs`, `node.js` | + | PHP | `php` | | + | Go | `go` | `golang` | + | Java | `java` | | + | Ruby | `ruby` | `rb` | + | PowerShell | `powershell` | | + | Swift | `swift` | | + | C# | `csharp` | `c#` | + | .NET | `dotnet` | `.net`, `dot-net` | + | TypeScript | `typescript` | `ts` | + | C | `c` | | + | C++ | `c++` | `cpp` | + | Kotlin | `kotlin` | `kt` | + | Rust | `rust` | `rs` | + | Dart | `dart` | `flutter` | + Whether to show optional parameters in API examples. Defaults to `all`. diff --git a/api/assistant/create-assistant-message-v2.mdx b/api/assistant/create-assistant-message-v2.mdx index 4c738407b..06c7bf7a2 100644 --- a/api/assistant/create-assistant-message-v2.mdx +++ b/api/assistant/create-assistant-message-v2.mdx @@ -1,5 +1,4 @@ --- -tag: "Latest" openapi: /discovery-openapi.json POST /v2/assistant/{domain}/message keywords: [ diff --git a/api/introduction.mdx b/api/introduction.mdx index e763a6dc7..50480703b 100644 --- a/api/introduction.mdx +++ b/api/introduction.mdx @@ -8,23 +8,23 @@ The Mintlify REST API enables you to programmatically interact with your documen ## Endpoints -- [Trigger update](/api-reference/update/trigger): Trigger an update of your site when desired. -- [Get update status](/api-reference/update/status): Get the status of an update and other details about your docs. -- [Create agent job](/api-reference/agent/create-agent-job): Create an agent job to automatically edit your documentation. -- [Get agent job](/api-reference/agent/get-agent-job): Retrieve the details and status of a specific agent job. -- [Get all agent jobs](/api-reference/agent/get-all-jobs): Retrieve all agent jobs for a domain. -- [Generate assistant message](/api-reference/assistant/create-assistant-message): Embed the assistant, trained on your docs, into any application of your choosing. -- [Search documentation](/api-reference/assistant/search): Search through your documentation. -- [Get user feedback](/api-reference/analytics/feedback): Export user feedback from your documentation. -- [Get assistant conversations](/api-reference/analytics/assistant-conversations): Export AI assistant conversation history. +- [Trigger update](/api/update/trigger): Trigger an update of your site when desired. +- [Get update status](/api/update/status): Get the status of an update and other details about your docs. +- [Create agent job](/api/agent/create-agent-job): Create an agent job to automatically edit your documentation. +- [Get agent job](/api/agent/get-agent-job): Retrieve the details and status of a specific agent job. +- [Get all agent jobs](/api/agent/get-all-jobs): Retrieve all agent jobs for a domain. +- [Generate assistant message](/api/assistant/create-assistant-message): Embed the assistant, trained on your docs, into any application of your choosing. +- [Search documentation](/api/assistant/search): Search through your documentation. +- [Get user feedback](/api/analytics/feedback): Export user feedback from your documentation. +- [Get assistant conversations](/api/analytics/assistant-conversations): Export AI assistant conversation history. ### Common use cases -- **Automated deployments**: Trigger site updates at set intervals or when events occur with [Trigger update](/api-reference/update/trigger) and [Get update status](/api-reference/update/status). -- **CI/CD integration**: Update documentation as part of your deployment pipeline when code changes with [Trigger update](/api-reference/update/trigger). -- **Custom integrations**: Embed the AI assistant into your product, support portal, or internal tools with [Generate assistant message](/api-reference/assistant/create-assistant-message) and [Search documentation](/api-reference/assistant/search). -- **Automated editing**: Use agent jobs to programmatically update documentation at scale with [Create agent job](/api-reference/agent/create-agent-job), [Get agent job](/api-reference/agent/get-agent-job), and [Get all agent jobs](/api-reference/agent/get-all-jobs). -- **Analytics export**: Export feedback and assistant conversations for external analysis with [Get user feedback](/api-reference/analytics/feedback) and [Get assistant conversations](/api-reference/analytics/assistant-conversations). +- **Automated deployments**: Trigger site updates at set intervals or when events occur with [Trigger update](/api/update/trigger) and [Get update status](/api/update/status). +- **CI/CD integration**: Update documentation as part of your deployment pipeline when code changes with [Trigger update](/api/update/trigger). +- **Custom integrations**: Embed the AI assistant into your product, support portal, or internal tools with [Generate assistant message](/api/assistant/create-assistant-message) and [Search documentation](/api/assistant/search). +- **Automated editing**: Use agent jobs to programmatically update documentation at scale with [Create agent job](/api/agent/create-agent-job), [Get agent job](/api/agent/get-agent-job), and [Get all agent jobs](/api/agent/get-all-jobs). +- **Analytics export**: Export feedback and assistant conversations for external analysis with [Get user feedback](/api/analytics/feedback) and [Get assistant conversations](/api/analytics/assistant-conversations). ## Authentication @@ -34,7 +34,7 @@ You can create up to 10 API keys per hour per organization. ### Admin API key -Use the admin API key to authenticate requests to [Trigger update](/api-reference/update/trigger), [Get update status](/api-reference/update/status), [Create agent job](/api-reference/agent/create-agent-job), [Get agent job](/api-reference/agent/get-agent-job), [Get all agent jobs](/api-reference/agent/get-all-jobs), [Get user feedback](/api-reference/analytics/feedback), and [Get assistant conversations](/api-reference/analytics/assistant-conversations). +Use the admin API key to authenticate requests to [Trigger update](/api/update/trigger), [Get update status](/api/update/status), [Create agent job](/api/agent/create-agent-job), [Get agent job](/api/agent/get-agent-job), [Get all agent jobs](/api/agent/get-all-jobs), [Get user feedback](/api/analytics/feedback), and [Get assistant conversations](/api/analytics/assistant-conversations). Admin API keys begin with the `mint_` prefix. @@ -42,7 +42,7 @@ The admin API key is a server-side secret. Do not expose it in client-side code. ### Assistant API key -Use the assistant API key to authenticate requests to [Generate assistant message](/api-reference/assistant/create-assistant-message) and [Search documentation](/api-reference/assistant/search) endpoints. +Use the assistant API key to authenticate requests to [Generate assistant message](/api/assistant/create-assistant-message) and [Search documentation](/api/assistant/search) endpoints. Assistant API keys begin with the `mint_dsc_` prefix. diff --git a/changelog.mdx b/changelog.mdx index 1d76705bf..46a113906 100644 --- a/changelog.mdx +++ b/changelog.mdx @@ -5,6 +5,33 @@ rss: true noindex: true --- + + + ## Self-serve SSO configuration + + Enterprise customers can now configure SAML SSO (Okta or Microsoft Entra) directly from the dashboard, including just-in-time (JIT) provisioning, provider switching, and connection removal. + + ## Viewer role + + New viewer role with read-only access to your dashboard. Viewers can see content in the editor, but they cannot edit content, invite members, or modify configurations. + + ## Human/AI traffic toggle + + The analytics page now shows separate human and AI traffic tabs. + + ## Slash command menu redesign + + The editor slash menu now features type-to-search, improved keyboard navigation, and other UX improvements. + + ## Bug fixes + + - Fixed table cell overflow in dashboard tables. + - Renaming files via the configuration sheet in the editor now properly saves changes. + - MDX parsing errors, like an unclosed `` tag, now update dynamically as you fix them instead of persisting incorrectly across reloads. + - Drag-and-drop handles in the editor now align correctly with different content types like headings or paragraphs with consistent sizing and better hit areas. + + + ## Skills installation simplified @@ -271,7 +298,7 @@ noindex: true - Fixed image uploading from visual mode in the editor. Now images upload with correct paths and improved path resolution handles absolute and relative paths. - Fixed sync operation to properly update currently opened files so that the editor shows the most up-to-date content. - Improved branch fetching with automatic updates every 15 minutes. - - Fixed branch creation workflow to correctly populate folder structure when creating new branchs without moving uncommitted changes. + - Fixed branch creation workflow to correctly populate folder structure when creating new branches without moving uncommitted changes. - Fixed folder duplication issue when creating new branches. ## Assistant improvements diff --git a/components/examples.mdx b/components/examples.mdx index ce52b2807..ac0704863 100644 --- a/components/examples.mdx +++ b/components/examples.mdx @@ -34,7 +34,7 @@ curl --request POST \ ## RequestExample -Use `` to pins code examples in the right sidebar. This component works similarly to the [CodeGroup](/components/code-groups) component, but displays the code in the sidebar instead of inline. +Use `` to pin code examples in the right sidebar. This component works similarly to the [CodeGroup](/components/code-groups) component, but displays the code in the sidebar instead of inline. You can include multiple code blocks inside a single ``. Each code block must have a title attribute. diff --git a/components/icons.mdx b/components/icons.mdx index bb1f31f50..24c7a3a82 100644 --- a/components/icons.mdx +++ b/components/icons.mdx @@ -1,12 +1,12 @@ --- title: "Icons" description: "Use icons from popular libraries, external URLs, or files in your project." -keywords: ["Font Awesome", "Lucide", "SVGs"] +keywords: ["Font Awesome", "Lucide", "Tabler", "SVGs"] --- import IconsRequired from "/snippets/icons-required.mdx"; -Use icons from Font Awesome, Lucide, SVGs, external URLs, or files in your project to enhance your documentation. +Use icons from Font Awesome, Lucide, Tabler, SVGs, external URLs, or files in your project to enhance your documentation. diff --git a/create/code.mdx b/create/code.mdx index 62c6bdc30..3d29462ad 100644 --- a/create/code.mdx +++ b/create/code.mdx @@ -312,9 +312,9 @@ checked_out: bool = False due_date: Optional[datetime] = None class Library: -def **init**(self): -self.books: Dict[str, Book] = {} -self.checkouts: Dict[str, List[str]] = {} # patron -> list of ISBNs + def __init__(self): + self.books: Dict[str, Book] = {} + self.checkouts: Dict[str, List[str]] = {} # patron -> list of ISBNs def add_book(self, book: Book) -> None: if book.isbn in self.books: @@ -368,7 +368,7 @@ self.checkouts: Dict[str, List[str]] = {} # patron -> list of ISBNs ] def main(): -library = Library() + library = Library() # Add some books books = [ @@ -384,8 +384,8 @@ library = Library() late_fee = library.return_book("978-0-261-10295-4") print(f"Late fee: ${late_fee:.2f}") -if **name** == "**main**": -main() +if __name__ == "__main__": + main() ``` ````text Format diff --git a/create/files.mdx b/create/files.mdx index 3df0de111..203b174eb 100644 --- a/create/files.mdx +++ b/create/files.mdx @@ -1,7 +1,7 @@ --- title: "Files" description: "Serve static assets from your documentation." -keywords: ["static assets", "supported file types"] +keywords: ["static assets","supported file types"] --- Mintlify automatically serves static assets from your documentation repository at the appropriate path on your domain. For example, if you have `/images/my-logo.png` in your repo, the image file is available at `https://docs.your-project.com/images/my-logo.png`. @@ -11,12 +11,13 @@ You can make any supported file type available to your users, including OpenAPI Files must be less than 20 MB for images and 100 MB for other file types. -File serving is not supported for documentation sites with authentication enabled. If your site requires authentication, static files will not be accessible at their direct URLs. + File serving is not supported for documentation sites with authentication enabled. If your site requires authentication, static files will not be accessible at their direct URLs. ## Supported file types Supported file types for all plans: + - **Images**: `.png`, `.jpg`, `.jpeg`, `.gif`, `.webp`, `.svg`, `.ico` - **Video**: `.mp4`, `.webm` - **Audio**: `.mp3`, `.wav` @@ -26,6 +27,7 @@ Supported file types for all plans: - **Fonts**: `.woff`, `.woff2`, `.ttf`, `.eot` Supported file types for Enterprise plans: + - **Documents**: `.pdf`, `.txt` - **Data**: `.xml`, `.csv` - **Archives**: `.zip` @@ -46,4 +48,4 @@ Organize your files using folders to keep your repository easy to navigate: |- demo-video.mp4 ``` -Files are served from the root of your domain, so the structure in your repository directly maps to the URL structure. From the previous example, `assets/whitepaper.pdf` would be available at `https://docs.your-project.com/assets/whitepaper.pdf`. +Files are served from the root of your domain, so the structure in your repository directly maps to the URL structure. From the previous example, `assets/whitepaper.pdf` would be available at `https://docs.your-project.com/assets/whitepaper.pdf`. \ No newline at end of file diff --git a/dashboard/permissions.mdx b/dashboard/permissions.mdx index 91fb55883..d3ce45429 100644 --- a/dashboard/permissions.mdx +++ b/dashboard/permissions.mdx @@ -1,17 +1,9 @@ --- -title: "Editor permissions" -description: "Allow more members of your team to update your documentation." -keywords: ["editor access", "permissions", "team", "seats"] +title: "Deployment permissions" +description: "Understand deployment differences between people in your organization and other contributors." +keywords: ["editor access", "permissions", "team", "seats", "deployment"] --- -An editor has access to your dashboard and web editor. +People with the editor or admin [role](/dashboard/roles) can use the web editor, trigger deployments, and manage integrations from your dashboard. When an editor or admin publishes through the web editor or merges a pull request into your documentation repository, the changes deploy to your live site automatically. -Anyone can contribute to your documentation by working locally and pushing changes to your repository, but there are key differences in how changes get deployed: - -* **Editor changes**: When an editor publishes through the web editor or merges a pull request into your docs repository, changes deploy to your live site automatically. -* **Non-editor changes**: When a non-editor merges a pull request into your repository, you must manually trigger a deployment from your dashboard for those changes to appear on your live site. - -## Add editors -By default, the team member who created your Mintlify organization has editor access. Add additional editors in the [Members](https://dashboard.mintlify.com/settings/organization/members) page of your dashboard. - -Editor seats are billed based on usage, and you can have as many editors as you need. See our [pricing page](https://mintlify.com/pricing) for more details. +Anyone with access to your documentation repository can contribute to your documentation by pushing changes to the repository, but their changes do not deploy until an editor or admin manually triggers a deployment from your dashboard. diff --git a/dashboard/roles.mdx b/dashboard/roles.mdx index 823a928c4..e8850e7f2 100644 --- a/dashboard/roles.mdx +++ b/dashboard/roles.mdx @@ -1,28 +1,41 @@ --- title: "Roles" -description: "Assign Owner, Admin, or Editor roles to manage team access and permissions." -keywords: ["RBAC", "role-based access control", "Admin", "permissions"] +description: "Assign admin, editor, or viewer roles to manage team access and permissions." +keywords: ["RBAC", "role-based access control", "admin", "editor", "viewer", "permissions"] --- - Role based access control (RBAC) is available on [Enterprise plans](https://mintlify.com/pricing?ref=rbac). + Role-based access control (RBAC) is available on [Enterprise plans](https://mintlify.com/pricing?ref=rbac). -Mintlify provides two dashboard access levels: Editor and Admin. +Mintlify provides three dashboard access levels: viewer, editor, and admin. -The following describes actions that are limited to the Admin role: +| | Viewer | Editor | Admin | +| ------------------------------ | :----: | :----: | :---: | +| View content in the editor | ✅ | ✅ | ✅ | +| View dashboard and analytics | ✅ | ✅ | ✅ | +| Edit content in the web editor | ❌ | ✅ | ✅ | +| Trigger deployments | ❌ | ✅ | ✅ | +| Create and delete API keys | ❌ | ✅ | ✅ | +| Configure integrations | ❌ | ✅ | ✅ | +| Configure assistant | ❌ | ✅ | ✅ | +| Configure add-ons | ❌ | ✅ | ✅ | +| Invite editors and viewers | ❌ | ✅ | ✅ | +| Update user roles | ❌ | ❌ | ✅ | +| Invite admins | ❌ | ❌ | ✅ | +| Delete users | ❌ | ❌ | ✅ | +| Manage billing | ❌ | ❌ | ✅ | +| Manage SSO | ❌ | ❌ | ✅ | +| Update custom domain | ❌ | ❌ | ✅ | +| Update Git source | ❌ | ❌ | ✅ | +| Delete organization | ❌ | ❌ | ✅ | -| | Editor | Admin | -| ----------------------- | :----: | :---: | -| Update user roles | ❌ | ✅ | -| Delete users | ❌ | ✅ | -| Invite admin users | ❌ | ✅ | -| Manage & update billing | ❌ | ✅ | -| Update custom domain | ❌ | ✅ | -| Update Git source | ❌ | ✅ | -| Delete org | ❌ | ✅ | + + Limit admin access to only the people who need to perform admin tasks. + -Other actions on the dashboard are available to both roles. +## Add members to your organization -You can invite as many admins as you want, but we recommend limiting admin -access to users who need it. +By default, the person who creates your Mintlify organization has admin access. Add additional editors in the [Members](https://dashboard.mintlify.com/settings/organization/members) page of your dashboard. + +You can have as many members as you need in your organization. Seats can incur additional costs. See the [pricing page](https://mintlify.com/pricing) for more details. diff --git a/dashboard/security-contact.mdx b/dashboard/security-contact.mdx new file mode 100644 index 000000000..259202c35 --- /dev/null +++ b/dashboard/security-contact.mdx @@ -0,0 +1,15 @@ +--- +title: "Security contact" +description: "Set an email address for communications related to customer and platform security." +keywords: ["security", "notifications", "compliance"] +--- + + + Security contact is available on [Pro and Enterprise plans](https://mintlify.com/pricing?ref=security-contact). + + +List a security contact in your dashboard to receive security-related communications about your organization. + +## Configure a security contact + +To add, update, or remove a security contact, navigate to the [Security contact](https://dashboard.mintlify.com/settings/organization/security-contact) page of your dashboard. diff --git a/dashboard/sso.mdx b/dashboard/sso.mdx index d86045019..7e1dfff59 100644 --- a/dashboard/sso.mdx +++ b/dashboard/sso.mdx @@ -1,130 +1,160 @@ --- title: "Single sign-on (SSO)" description: "Set up SAML or OIDC with identity providers for team authentication." -keywords: ["SAML authentication", "OIDC", "Okta integration", "identity provider"] +keywords: ["SSO", "SAML authentication", "Okta integration", "Microsoft Entra", "identity provider", "JIT", "provisioning", "OIDC"] --- SSO is available on [Enterprise plans](https://mintlify.com/pricing?ref=sso). -Use single sign-on to your dashboard via SAML and OIDC. If you use Okta, Google Workspace, or Microsoft Entra, we have provider-specific documentation for setting up SSO. If you use another provider, please [contact us](mailto:support@mintlify.com). - -## Okta - - - - - - Under `Applications`, click to create a new app integration using SAML 2.0. - - - Enter the following: - * Single sign-on URL (provided by Mintlify) - * Audience URI (provided by Mintlify) - * Name ID Format: `EmailAddress` - * Attribute Statements: - | Name | Name format | Value - | ---- | ----------- | ----- - | `firstName` | Basic | `user.firstName` | - | `lastName` | Basic | `user.lastName` | - - - Once the application is set up, navigate to the sign-on tab and send us the metadata URL. - We'll enable the connection from our side using this information. - - - - - - - Under `Applications`, click to create a new app integration using OIDC. - You should choose the `Web Application` application type. - - - Select the authorization code grant type and enter the Redirect URI provided by Mintlify. - - - Once the application is set up, navigate to the General tab and locate the client ID & client secret. - Please securely provide us with these, along with your Okta instance URL (for example, `.okta.com`). You can send these via a service like 1Password or SendSafely. - - - - - -## Google Workspace - - - - - - Under `Web and mobile apps`, select `Add custom SAML app` from the `Add app` dropdown. - - ![Screenshot of the Google Workspace SAML application creation page with the "Add custom SAML app" menu item highlighted](/images/gsuite-add-custom-saml-app.png) - - - - Copy the provided SSO URL, Entity ID, and x509 certificate and send it to the Mintlify team. - - ![Screenshot of the Google Workspace SAML application page with the SSO URL, Entity ID, and x509 certificate highlighted. The specific values for each of these are blurred out.](/images/gsuite-saml-metadata.png) - - - - On the Service provider details page, enter the following: - * ACS URL (provided by Mintlify) - * Entity ID (provided by Mintlify) - * Name ID format: `EMAIL` - * Name ID: `Basic Information > Primary email` - - - ![Screenshot of the Service provider details page with the ACS URL and Entity ID input fields highlighted.](/images/gsuite-sp-details.png) - - - On the next page, enter the following attribute statements: - | Google Directory Attribute | App Attribute | - | -------------------------- | ------------- | - | `First name` | `firstName` | - | `Last name` | `lastName` | - - Once this step is complete and users are assigned to the application, let our team know and we'll enable SSO for your account! - - - - - -## Microsoft Entra - - - - - - 1. Under "Enterprise applications," select **New application**. - 2. Select **Create your own application** and choose "Integrate any other application you don't find in the gallery (Non-gallery)." - - - Navigate to the Single Sign-On setup page and select **SAML**. Under "Basic SAML Configuration," enter the following: - * Identifier (Entity ID): The Audience URI provided by Mintlify. - * Reply URL (Assertion Consumer Service URL): The ACS URL provided by Mintlify. - - Leave the other values blank and select **Save**. - - - Edit the Attributes & Claims section: - 1. Select **Unique User Identifier (Name ID)** under "Required Claim." - 2. Change the Source attribute to use `user.primaryauthoritativeemail`. - 3. Under Additional claims, create the following claims: - | Name | Value | - | ---- | ----- | - | `firstName` | `user.givenname` | - | `lastName` | `user.surname` | - - - Once the application is set up, navigate to the "SAML Certificates" section and send us the App Federation Metadata URL. - We'll enable the connection from our side using this information. - - - Navigate to "Users and groups" in your Entra application and add the users who should have access to your dashboard. - - - - +Enterprise admins can configure SAML SSO for Okta or Microsoft Entra directly from the Mintlify dashboard. For other providers like Google Workspace or Okta OIDC, [contact us](mailto:support@mintlify.com) to set up SSO. + +## Set up SSO + +### Okta + + + + 1. In your Mintlify dashboard, navigate to the [Single Sign-On](https://dashboard.mintlify.com/settings/organization/sso) page. + 2. Click **Configure**. + 3. Select **Okta SAML**. + 4. Copy the **Single sign on URL** and **Audience URI**. + + + 1. In Okta, under **Applications**, create a new app integration using SAML 2.0. + 2. Enter the following from Mintlify: + * **Single sign on URL**: the URL you copied from your Mintlify dashboard + * **Audience URI**: the URI you copied from your Mintlify dashboard + * **Name ID Format**: `EmailAddress` + + 4. Add these attribute statements: + + | Name | Name format | Value | + | ---- | ----------- | ----- | + | `firstName` | Basic | `user.firstName` | + | `lastName` | Basic | `user.lastName` | + + + In Okta, go to the **Sign On** tab of your application and copy the metadata URL. + + + Back in the Mintlify dashboard, paste the metadata URL and click **Save changes**. + + + +### Microsoft Entra + + + + 1. In your Mintlify dashboard, navigate to the [Single Sign-On](https://dashboard.mintlify.com/settings/organization/sso) page. + 2. Click **Configure**. + 3. Select **Microsoft Entra ID SAML**. + 4. Copy the **Single sign on URL** and **Audience URI**. + + + 1. In Microsoft Entra, navigate to **Enterprise applications**. + 2. Select **New application**. + 3. Select **Create your own application**. + 4. Select "Integrate any other application you don't find in the gallery (Non-gallery)." + + + 1. In Microsoft Entra, navigate to **Single Sign-On**. + 2. Select **SAML**. + 3. Under **Basic SAML Configuration**, enter the following: + * **Identifier (Entity ID)**: the Audience URI from Mintlify + * **Reply URL (Assertion Consumer Service URL)**: the Single sign on URL from Mintlify + + Leave the other values blank and select **Save**. + + + 1. In Microsoft Entra, navigate to **Attributes & Claims**. + 2. Select **Unique User Identifier (Name ID)** under "Required Claim." + 3. Change the Source attribute to `user.primaryauthoritativeemail`. + 4. Under **Additional claims**, create the following: + | Name | Value | + | ---- | ----- | + | `firstName` | `user.givenname` | + | `lastName` | `user.surname` | + + + Under **SAML Certificates**, copy the **App Federation Metadata URL**. + + + Back in the Mintlify dashboard, paste the metadata URL and click **Save changes**. + + + In Microsoft Entra, navigate to **Users and groups**. Assign the users who should have access to your Mintlify dashboard. + + + +## JIT provisioning + +When you enable JIT (just-in-time) provisioning, users who sign in through your identity provider are automatically added to your Mintlify organization. + +To enable JIT provisioning, you must have SSO enabled. Navigate to the [Single Sign-On](https://dashboard.mintlify.com/settings/organization/sso) page in your dashboard, set up SSO, and then enable JIT provisioning. + +## Change or remove SSO provider + +1. Navigate to the [Single Sign-On](https://dashboard.mintlify.com/settings/organization/sso) page in your dashboard. +2. Click **Configure**. +3. Select your preferred SSO provider or no SSO. + +If you remove SSO, users must authenticate with a password, magic link, or Google OAuth instead. + +## Other providers + +For providers other than Microsoft Entra or Okta SAML, [contact us](mailto:support@mintlify.com) to configure SSO. + +### Google Workspace (SAML) + + + + 1. In Google Workspace, navigate to **Web and mobile apps**. + 2. Select **Add custom SAML app** from the **Add app** dropdown. + + ![Screenshot of the Google Workspace SAML application creation page with the "Add custom SAML app" menu item highlighted](/images/gsuite-add-custom-saml-app.png) + + + + Copy the provided SSO URL, Entity ID, and x509 certificate and send it to the Mintlify team. + + ![Screenshot of the Google Workspace SAML application page with the SSO URL, Entity ID, and x509 certificate highlighted. The specific values for each of these are blurred out.](/images/gsuite-saml-metadata.png) + + + + On the Service provider details page, enter the following: + + * ACS URL (provided by Mintlify) + * Entity ID (provided by Mintlify) + * Name ID format: `EMAIL` + * Name ID: `Basic Information > Primary email` + + + ![Screenshot of the Service provider details page with the ACS URL and Entity ID input fields highlighted.](/images/gsuite-sp-details.png) + + + On the next page, enter the following attribute statements: + + | Google Directory Attribute | App Attribute | + | -------------------------- | ------------- | + | `First name` | `firstName` | + | `Last name` | `lastName` | + + Once this step is complete and users are assigned to the application, let our team know and we'll enable SSO for your account. + + + +### Okta (OIDC) + + + + In Okta, under **Applications**, create a new app integration using OIDC. Choose the **Web Application** application type. + + + Select the authorization code grant type and enter the Redirect URI provided by Mintlify. + + + Navigate to the **General** tab and locate the client ID and client secret. Securely provide these to us along with your Okta instance URL (for example, `.okta.com`). You can send these via a service like 1Password or SendSafely. + + diff --git a/deploy/authentication-setup.mdx b/deploy/authentication-setup.mdx index 980c1fa9e..d0b02fad5 100644 --- a/deploy/authentication-setup.mdx +++ b/deploy/authentication-setup.mdx @@ -32,7 +32,7 @@ Select the handshake method that you want to configure. - 1. In your dashboard, go to [Authentication](https://dashboard.mintlify.com/settings/deployment/authentication). + 1. In your dashboard, go to [Authentication](https://dashboard.mintlify.com/products/authentication). 2. Enable authentication. 3. In the **Password Protection** section, enter a secure password @@ -58,7 +58,7 @@ You host your documentation at `docs.foo.com` and you need basic access control - 1. In your dashboard, go to [Authentication](https://dashboard.mintlify.com/settings/deployment/authentication). + 1. In your dashboard, go to [Authentication](https://dashboard.mintlify.com/products/authentication). 2. Enable authentication. 3. In the **Custom Authentication** section, click **Mintlify Auth**. 4. Click **Enable Mintlify Auth**. @@ -90,7 +90,7 @@ You host your documentation at `docs.foo.com` and your entire team has access to - 1. In your dashboard, go to [Authentication](https://dashboard.mintlify.com/settings/deployment/authentication). + 1. In your dashboard, go to [Authentication](https://dashboard.mintlify.com/products/authentication). 2. Enable authentication. 3. In the **Custom Authentication** section, click **OAuth**. 4. Configure these fields: @@ -108,7 +108,7 @@ You host your documentation at `docs.foo.com` and your entire team has access to After you configure your OAuth settings, your site redeploys. When it finishes deploying, anyone who visits your site must log in to your OAuth provider to access your content. - 1. Copy the **Redirect URL** from your [authentication settings](https://dashboard.mintlify.com/settings/deployment/authentication). + 1. Copy the **Redirect URL** from your [authentication settings](https://dashboard.mintlify.com/products/authentication). 2. Add the redirect URL as an authorized redirect URL for your OAuth server. @@ -119,7 +119,7 @@ You host your documentation at `docs.foo.com` and your entire team has access to Mintlify calls this endpoint with the OAuth access token to retrieve user information. No additional query parameters are sent. - Add this endpoint URL to the **Info API URL** field in your [authentication settings](https://dashboard.mintlify.com/settings/deployment/authentication). + Add this endpoint URL to the **Info API URL** field in your [authentication settings](https://dashboard.mintlify.com/products/authentication). @@ -165,7 +165,7 @@ You host your documentation at `foo.com/docs` and you have an existing OAuth ser - 1. In your dashboard, go to [Authentication](https://dashboard.mintlify.com/settings/deployment/authentication). + 1. In your dashboard, go to [Authentication](https://dashboard.mintlify.com/products/authentication). 2. Enable authentication. 3. In the **Custom Authentication** section, click **JWT**. 4. Enter the URL of your existing login flow. diff --git a/deploy/ci.mdx b/deploy/ci.mdx index bb3487b6f..d5483fb3d 100644 --- a/deploy/ci.mdx +++ b/deploy/ci.mdx @@ -89,7 +89,7 @@ mintlify VSCode openapi OpenAPI -Github +GitHub APIs repo diff --git a/deploy/deployments.mdx b/deploy/deployments.mdx index b2c722adf..eb1285266 100644 --- a/deploy/deployments.mdx +++ b/deploy/deployments.mdx @@ -1,7 +1,7 @@ --- title: "Deployments" description: "Manage deployments, view history, and monitor status." -keywords: ["manual deployment", "deployment history", "deployment triggers"] +keywords: ["manual deployment", "deployment history", "deployment triggers", "delete deployment"] --- Your documentation site automatically deploys when you push changes to your connected repository. This requires the Mintlify GitHub app to be properly installed and connected. diff --git a/deploy/github.mdx b/deploy/github.mdx index 0c2ec57ef..83bd8d027 100644 --- a/deploy/github.mdx +++ b/deploy/github.mdx @@ -127,7 +127,9 @@ If you encounter problems with the GitHub app, resetting the connection can solv ### Feedback add-ons are unavailable -If you cannot enable the edit suggestions or raise issues options in your dashboard and your repository is public, revalidate your Git settings. +The edit suggestions and raise issues feedback features are only available for public GitHub repositories. If these options are disabled in your dashboard, check your repository visibility. + +If your repository is public and you cannot enable the edit suggestions or raise issues options in your dashboard, revalidate your Git settings. diff --git a/deploy/reverse-proxy.mdx b/deploy/reverse-proxy.mdx index 9433627f6..1bcd67912 100644 --- a/deploy/reverse-proxy.mdx +++ b/deploy/reverse-proxy.mdx @@ -30,7 +30,7 @@ Before configuring your reverse proxy: 3. Enter your domain and select **Add domain**. - Enabling **Host at `/docs`** stops cache invalidation on `mintlify.app`. You must proxy to `mintlify.dev` for updates to appear. + When you enable **Host at `/docs`**, your canonical docs URL becomes `.mintlify.dev`. Cache invalidation stops on `mintlify.app`, and you must proxy to `mintlify.dev` for updates to appear. ### Routing configuration diff --git a/discovery-openapi.json b/discovery-openapi.json index 931da329a..0dd00212b 100644 --- a/discovery-openapi.json +++ b/discovery-openapi.json @@ -417,7 +417,7 @@ }, "/v2/assistant/{domain}/message": { "post": { - "summary": "Assistant message v2", + "summary": "Assistant message", "description": "Generates a response message from the assistant for the specified domain. Compatible with AI SDK v5+.", "parameters": [ { diff --git a/docs.json b/docs.json index 25a0a36c8..7e92ab2b7 100644 --- a/docs.json +++ b/docs.json @@ -51,15 +51,6 @@ "customize/fonts", "customize/custom-scripts", "customize/react-components", - { - "group": "Dashboard access", - "pages": [ - "dashboard/sso", - "dashboard/permissions", - "dashboard/roles", - "dashboard/audit-logs" - ] - }, "customize/custom-404-page" ] }, @@ -167,6 +158,16 @@ ] }, "deploy/authentication-setup", + { + "group": "Dashboard access", + "pages": [ + "dashboard/sso", + "dashboard/permissions", + "dashboard/roles", + "dashboard/audit-logs", + "dashboard/security-contact" + ] + }, "deploy/monorepo", "deploy/vercel-external-proxies", "deploy/ci", @@ -341,7 +342,6 @@ "icon": "bot-message-square", "pages": [ "api/assistant/create-assistant-message-v2", - "api/assistant/create-assistant-message", "api/assistant/search" ] }, @@ -405,15 +405,6 @@ "fr/customize/fonts", "fr/customize/custom-scripts", "fr/customize/react-components", - { - "group": "Accéder au Dashboard", - "pages": [ - "fr/dashboard/sso", - "fr/dashboard/permissions", - "fr/dashboard/roles", - "fr/dashboard/audit-logs" - ] - }, "fr/customize/custom-404-page" ] }, @@ -439,7 +430,7 @@ "fr/create/text", "fr/create/code", { - "group": "Assistant", + "group": "Assistant IA", "pages": [ "fr/agent/index", "fr/agent/quickstart", @@ -489,7 +480,7 @@ ] }, { - "group": "Documenter vos API", + "group": "Documenter des API", "icon": "file-json", "pages": [ "fr/api-playground/overview", @@ -510,7 +501,7 @@ "fr/deploy/deployments", "fr/deploy/preview-deployments", { - "group": "Sous-chemin /docs", + "group": "/docs en sous-chemin", "pages": [ "fr/deploy/docs-subpath", "fr/deploy/cloudflare", @@ -521,6 +512,16 @@ ] }, "fr/deploy/authentication-setup", + { + "group": "Accès au Dashboard", + "pages": [ + "fr/dashboard/sso", + "fr/dashboard/permissions", + "fr/dashboard/roles", + "fr/dashboard/audit-logs", + "fr/dashboard/security-contact" + ] + }, "fr/deploy/monorepo", "fr/deploy/vercel-external-proxies", "fr/deploy/ci", @@ -577,7 +578,7 @@ ] }, { - "group": "Support", + "group": "Assistance", "pages": [ "fr/integrations/support/overview", "fr/integrations/support/intercom", @@ -653,7 +654,7 @@ ] }, { - "group": "Cas d’usage", + "group": "Cas d’utilisation", "icon": "blocks", "pages": [ "fr/guides/developer-documentation", @@ -664,7 +665,7 @@ ] }, { - "tab": "Référence API", + "tab": "Référence de l’API", "groups": [ { "group": "Référence de l’API", @@ -695,7 +696,6 @@ "icon": "bot-message-square", "pages": [ "fr/api/assistant/create-assistant-message-v2", - "fr/api/assistant/create-assistant-message", "fr/api/assistant/search" ] }, @@ -710,7 +710,7 @@ ] }, { - "tab": "Journal des modifications", + "tab": "journal des modifications", "groups": [ { "group": "journal des modifications", @@ -759,15 +759,6 @@ "es/customize/fonts", "es/customize/custom-scripts", "es/customize/react-components", - { - "group": "Acceder al dashboard", - "pages": [ - "es/dashboard/sso", - "es/dashboard/permissions", - "es/dashboard/roles", - "es/dashboard/audit-logs" - ] - }, "es/customize/custom-404-page" ] }, @@ -793,7 +784,7 @@ "es/create/text", "es/create/code", { - "group": "Agente", + "group": "Asistente", "pages": [ "es/agent/index", "es/agent/quickstart", @@ -875,6 +866,16 @@ ] }, "es/deploy/authentication-setup", + { + "group": "Acceso al Dashboard", + "pages": [ + "es/dashboard/sso", + "es/dashboard/permissions", + "es/dashboard/roles", + "es/dashboard/audit-logs", + "es/dashboard/security-contact" + ] + }, "es/deploy/monorepo", "es/deploy/vercel-external-proxies", "es/deploy/ci", @@ -1028,7 +1029,7 @@ ] }, { - "group": "Administrador", + "group": "Administración", "icon": "activity", "pages": [ "es/api/update/trigger", @@ -1049,7 +1050,6 @@ "icon": "bot-message-square", "pages": [ "es/api/assistant/create-assistant-message-v2", - "es/api/assistant/create-assistant-message", "es/api/assistant/search" ] }, @@ -1064,7 +1064,7 @@ ] }, { - "tab": "Cambios", + "tab": "cambios", "groups": [ { "group": "cambios", @@ -1084,7 +1084,7 @@ "tab": "文档", "groups": [ { - "group": "入门", + "group": "快速入门", "icon": "rocket", "pages": [ "zh/index", @@ -1094,7 +1094,7 @@ ] }, { - "group": "组织与团队", + "group": "组织", "icon": "map", "pages": [ "zh/organize/settings", @@ -1105,7 +1105,7 @@ ] }, { - "group": "自定义配置", + "group": "自定义", "icon": "paint-bucket", "pages": [ "zh/customize/custom-domain", @@ -1113,15 +1113,6 @@ "zh/customize/fonts", "zh/customize/custom-scripts", "zh/customize/react-components", - { - "group": "访问控制台", - "pages": [ - "zh/dashboard/sso", - "zh/dashboard/permissions", - "zh/dashboard/roles", - "zh/dashboard/audit-logs" - ] - }, "zh/customize/custom-404-page" ] }, @@ -1147,7 +1138,7 @@ "zh/create/text", "zh/create/code", { - "group": "Agent", + "group": "AI 助手", "pages": [ "zh/agent/index", "zh/agent/quickstart", @@ -1229,6 +1220,16 @@ ] }, "zh/deploy/authentication-setup", + { + "group": "控制台访问", + "pages": [ + "zh/dashboard/sso", + "zh/dashboard/permissions", + "zh/dashboard/roles", + "zh/dashboard/audit-logs", + "zh/dashboard/security-contact" + ] + }, "zh/deploy/monorepo", "zh/deploy/vercel-external-proxies", "zh/deploy/ci", @@ -1372,7 +1373,7 @@ ] }, { - "tab": "API 参考", + "tab": "API 参考文档", "groups": [ { "group": "API 参考", @@ -1403,12 +1404,11 @@ "icon": "bot-message-square", "pages": [ "zh/api/assistant/create-assistant-message-v2", - "zh/api/assistant/create-assistant-message", "zh/api/assistant/search" ] }, { - "group": "Analytics", + "group": "数据分析", "icon": "chart-line", "pages": [ "zh/api/analytics/feedback", @@ -1552,6 +1552,7 @@ "copy", "chatgpt", "claude", + "add-mcp", "cursor", "vscode" ] diff --git a/editor/media.mdx b/editor/media.mdx index 769fce9be..5654957d8 100644 --- a/editor/media.mdx +++ b/editor/media.mdx @@ -1,13 +1,13 @@ --- title: "Add media" description: "Upload and use images and assets in your documentation." -keywords: ["editor", "media", "images", "assets"] +keywords: ["editor","media","images","assets"] --- ## Supported file types -- **Images**: PNG, JPG, JPEG, SVG, GIF, WebP -- **Videos**: MP4, WebM +- **Images**: PNG, JPG, JPEG, SVG, GIF, WebP (max 15MB) +- **Videos**: MP4, WebM (max 100MB) - **Fonts**: TTF, WOFF, WOFF2 - **Other**: PDF, ICO (favicons) @@ -15,19 +15,28 @@ keywords: ["editor", "media", "images", "assets"] ### Drag and drop -Drag and drop media from your computer or the asset manager onto a page in visual mode. Files save to the root of your `images/` folder. +Drag and drop media from your computer or the asset manager onto a page in visual mode. Images save to the root of your `images/` folder, and videos save to the root of your `videos/` folder. ### Slash command -Type /image to open the image menu, then upload a new image or select an existing one. +Type /image to open the image menu or /video to open the video menu. Upload new media or select from existing files. ### Upload files Use the asset manager in the sidebar to upload or search for files. - Assets manager selected in the editor sidebar menu. - Assets manager selected in the editor sidebar menu. + Assets manager selected in the editor sidebar menu. + + Assets manager selected in the editor sidebar menu. Click **Upload** in the asset manager to add files from your computer. @@ -51,4 +60,4 @@ Hover over an asset and click the delete button. - **Use descriptive names**: Name files clearly, like `api-dashboard-light.png` instead of `img1.png`. - **Add alt text**: Provide descriptive alt text for accessibility and SEO. - **Organize with folders**: Group related assets, such as light and dark mode variants or assets for a specific feature area. -- **Use appropriate formats**: PNG for graphics with transparency, JPG for photos, SVG for icons and logos. +- **Use appropriate formats**: PNG for graphics with transparency, JPG for photos, SVG for icons and logos. \ No newline at end of file diff --git a/editor/navigation.mdx b/editor/navigation.mdx index 42155b9c0..c9b54e766 100644 --- a/editor/navigation.mdx +++ b/editor/navigation.mdx @@ -15,9 +15,9 @@ Use the navigation sidebar to organize your documentation. Changes you make in t Add new navigation element. -To add a navigation element nested inside another element, click the **+** button next to the name of the parent element. +To add a navigation element nested inside another element, click the **+** plus button next to the name of the parent element. -After creating an element, drag-and-drop it to reorder or nest it within other elements. Right-click any element to configure its properties, duplicate it, hide it from navigation, or delete it. +After creating an element, drag-and-drop it to reorder or nest it within other elements. Hover over an element then click the gear icon to configure its properties, or right-click an element to access additional options like duplicate, convert to another element, or delete. Some elements cannot nest inside other elements. For example, tabs cannot nest inside groups. The web editor prevents you from nesting invalid elements. @@ -103,14 +103,14 @@ Each language maintains the same navigation structure with translated content. **Add icons:** -1. Right-click a navigation item. -2. Click **Configure**. +1. Hover over a navigation item. +2. Click the gear icon. 3. Click the icon field. **Add tags:** -1. Right-click a navigation item. -1. Click **Configure**. +1. Hover over a navigation item. +1. Click the gear icon. 1. Click the tag field. 1. Enter a tag like "NEW" or "BETA" that highlights important items. diff --git a/editor/pages.mdx b/editor/pages.mdx index 35da50ed1..d7b91eb2d 100644 --- a/editor/pages.mdx +++ b/editor/pages.mdx @@ -43,7 +43,8 @@ Edit content with real-time previews that show how the content looks when publis - **Add text**: Type in the editor to see how the text appears when published. - **Format text**: Use the toolbar to bold, italicize, or apply other formatting to text. - **Add components**: Press / to open the component menu and select components. -- **Add images**: Use the image component from the / menu. +- **Add images**: Use the image component from the / menu or type /image. +- **Add videos**: Type /video to upload or select a video. - **Insert links**: Select text and press Cmd + K. See [Components](/components) for the complete list of available components. @@ -62,8 +63,20 @@ See [Format text](/create/text) and [Format code](/create/code) for more informa Configure page settings to control how pages appear in navigation, search results, and your site layout. -1. Right-click a file. -2. Click **Configure**. +Hover over a page, then click the gear icon. You can also right-click a file and select **Settings**. + + + A page highlighted in the sidebar so that the settings gear icon is visible. + A page highlighted in the sidebar so that the settings gear icon is visible. + ### Customize navigation appearance @@ -107,4 +120,4 @@ Right-click a page and select **Delete**. Deleting a page removes it from your n ### Hide pages -To remove a page from navigation without deleting the file, right-click the page and click **Hide Page**. The file remains in your repository and you can unhide the page by adding it to your `docs.json` navigation. \ No newline at end of file +To remove a page from navigation without deleting the file, enable the **Hidden** toggle in the page settings. A hidden page remains in your repository and users can still access the page by navigating directly to the page's URL. You can unhide a page in the page settings or add it to your `docs.json` navigation. \ No newline at end of file diff --git a/es/advanced-support.mdx b/es/advanced-support.mdx index 03be8cda6..5c9b1fdc7 100644 --- a/es/advanced-support.mdx +++ b/es/advanced-support.mdx @@ -8,7 +8,7 @@ keywords: ["support", "CSM", "enterprise"] ## Opciones de soporte -- Todos los clientes reciben soporte a través del dashboard o support@mintlify.com (respuesta en 24-48 horas) +- Todos los clientes reciben soporte a través del dashboard o support@mintlify.com (respuesta en 24 horas) - Los clientes con planes Enterprise pueden añadir soporte avanzado por Slack (respuesta en 24 horas) o un CSM dedicado (respuesta en 4 horas + colaboración estratégica)
diff --git a/es/agent/index.mdx b/es/agent/index.mdx index bfd97acad..26fc58393 100644 --- a/es/agent/index.mdx +++ b/es/agent/index.mdx @@ -5,7 +5,7 @@ keywords: ["automation", "automate", "AI", "autoupdate", "maintenance"] --- - El agente está disponible en los [planes Pro y Enterprise](https://mintlify.com/pricing?ref=agent) para cualquier persona que tenga acceso a tu dashboard. + El agente está disponible en los [planes Enterprise](https://mintlify.com/pricing?ref=agent) para cualquier persona que tenga acceso a tu dashboard. El agente crea solicitudes de extracción (pull requests) con cambios propuestos para tu documentación a partir de tus indicaciones. Cuando envías una solicitud al agente, este consulta tu documentación, los repositorios conectados y los mensajes de Slack para crear contenido que siga las mejores prácticas de redacción técnica y cumpla con el esquema de Mintlify. @@ -33,7 +33,7 @@ Usa el agente para: El panel del agente abierto en el dashboard. * **Slack**: Añade el agente a tu espacio de trabajo de Slack y menciona `@mintlify` para activarlo. -* **API**: Integra el agente en aplicaciones personalizadas usando los [endpoints del agente](/es/api-reference/agent/create-agent-job). +* **API**: Integra el agente en aplicaciones personalizadas usando los [endpoints del agente](/es/api/agent/create-agent-job).
## Próximos pasos diff --git a/es/ai-native.mdx b/es/ai-native.mdx index c2f8e7231..2ef10ec6f 100644 --- a/es/ai-native.mdx +++ b/es/ai-native.mdx @@ -2,7 +2,7 @@ title: "Documentación nativa en IA" sidebarTitle: "Nativa en IA" description: "Aprende cómo la IA mejora la lectura, la redacción y la exploración de tu documentación" -keywords: ["AI", "assistant", "agent", "llms.txt", "MCP"] +keywords: ["AI","assistant","agent","llms.txt","MCP","llms-full.txt"] --- Cuando alojas tu documentación en Mintlify, las funciones de IA integradas ayudan a tus usuarios a encontrar respuestas y a tu equipo a mantener el contenido con mayor eficiencia. Tu contenido aporta el contexto para que estas funciones nativas de IA mejoren la experiencia de lectura, redacción y descubrimiento de tu documentación. @@ -15,13 +15,13 @@ Cuando alojas tu documentación en Mintlify, las funciones de IA integradas ayud ### Lectura
-Además de leer páginas individuales, los usuarios pueden chatear con el [assistant](/es/ai/assistant) en tu documentación para obtener respuestas inmediatas a sus preguntas y enlaces a contenido relevante. El assistant ayuda a guiar a los usuarios por tu producto con información precisa de tu documentación. Integra el assistant en aplicaciones personalizadas con la [API](api-reference/assistant/create-assistant-message) para ampliar los lugares desde los que los usuarios pueden acceder a tu documentación. +Además de leer páginas individuales, los usuarios pueden chatear con el [assistant](/es/ai/assistant) en tu documentación para obtener respuestas inmediatas a sus preguntas y enlaces a contenido relevante. El assistant ayuda a guiar a los usuarios por tu producto con información precisa de tu documentación. Integra el assistant en aplicaciones personalizadas con la [API](/es/api/assistant/create-assistant-message) para ampliar los lugares desde los que los usuarios pueden acceder a tu documentación.
### Redacción
-El [agente](/es/agent) te ayuda a redactar y mantener la documentación. Crea solicitudes de extracción con cambios propuestos basados en tus indicaciones, solicitudes de extracción y hilos de Slack. Añade el agente a tu espacio de trabajo de Slack para que cualquiera de tu equipo pueda ayudar a mantener la documentación conversando con él. O integra el agente en aplicaciones personalizadas a través de la [API](/es/api-reference/agent/create-agent-job). +El [agente](/es/agent) te ayuda a redactar y mantener la documentación. Crea solicitudes de extracción con cambios propuestos basados en tus indicaciones, solicitudes de extracción y hilos de Slack. Añade el agente a tu espacio de trabajo de Slack para que cualquiera de tu equipo pueda ayudar a mantener la documentación conversando con él. O integra el agente en aplicaciones personalizadas a través de la [API](/es/api/agent/create-agent-job). Puedes configurar el agente para que supervise los repositorios conectados y [sugiera](/es/agent/suggestions) de forma proactiva actualizaciones de la documentación cuando detecte cambios visibles para el usuario. diff --git a/es/ai/contextual-menu.mdx b/es/ai/contextual-menu.mdx index 08e5ca752..ff0d01c72 100644 --- a/es/ai/contextual-menu.mdx +++ b/es/ai/contextual-menu.mdx @@ -25,6 +25,7 @@ El menú contextual incluye varias opciones preconfiguradas que puedes habilitar | **Abrir en Perplexity** | `perplexity` | Crea una conversación en Perplexity con la página actual como contexto | | **Abrir en Grok** | `grok` | Crea una conversación en Grok con la página actual como contexto | | **Copiar URL del servidor MCP** | `mcp` | Copia la URL de tu servidor MCP al portapapeles | +| **Copiar comando de instalación del servidor MCP** | `add-mcp` | Copia el comando `npx add-mcp` para instalar el servidor MCP | | **Conectar con Cursor** | `cursor` | Instala tu servidor MCP alojado en Cursor | | **Conectar con VS Code** | `vscode` | Instala tu servidor MCP alojado en VS Code | | **Opciones personalizadas** | Object | Agrega opciones personalizadas al menú contextual | diff --git a/es/ai/llmstxt.mdx b/es/ai/llmstxt.mdx index f9f03ff46..15285f244 100644 --- a/es/ai/llmstxt.mdx +++ b/es/ai/llmstxt.mdx @@ -11,7 +11,7 @@ El [archivo llms.txt](https://llmstxt.org) es un estándar del sector que ayuda Mintlify aloja automáticamente un archivo `llms.txt` en la raíz de tu proyecto que lista todas las páginas disponibles de tu documentación. Este archivo siempre está actualizado y no requiere mantenimiento. Opcionalmente, puedes añadir un `llms.txt` personalizado en la raíz de tu proyecto. - Si tu sitio requiere autenticación para acceder a tu documentación, tus archivos `llms.txt` y `llms-full.txt` no estarán disponibles para los LLM ni para las herramientas de IA. Los LLM y las herramientas de IA solo pueden indexar contenido que sea públicamente accesible. + Si tu sitio requiere autenticación para acceder a tu documentación, tus archivos `llms.txt` y `llms-full.txt` no están disponibles para los LLM y las herramientas de IA. Los LLM y las herramientas de IA solo pueden indexar contenido que sea accesible públicamente. Consulta tu `llms.txt` añadiendo `/llms.txt` a la URL de tu sitio de documentación. @@ -44,7 +44,6 @@ La descripción de cada página proviene del campo `description` en su frontmatt Este enfoque estructurado permite a los LLM procesar tu documentación de forma eficiente a un alto nivel y localizar contenido relevante para las consultas de los usuarios, mejorando la precisión y la velocidad de las búsquedas de documentación asistidas por IA. -
## llms-full.txt
diff --git a/es/ai/model-context-protocol.mdx b/es/ai/model-context-protocol.mdx index 299421f8d..3174a9e28 100644 --- a/es/ai/model-context-protocol.mdx +++ b/es/ai/model-context-protocol.mdx @@ -36,10 +36,8 @@ La herramienta de búsqueda de Model Context Protocol (MCP) admite parámetros d * **`version`**: Filtra los resultados a una versión específica de la documentación. Por ejemplo, `'v0.7'`. Solo devuelve contenido etiquetado con la versión especificada o contenido disponible en todas las versiones. * **`language`**: Filtra los resultados a un código de idioma específico. Por ejemplo, `'en'`, `'zh'` o `'es'`. Solo devuelve contenido en el idioma especificado o contenido disponible en todos los idiomas. -* **`apiReferenceOnly`**: Cuando se configura en `true`, solo devuelve páginas de documentación de referencia de API. -* **`codeOnly`**: Cuando se configura en `true`, solo devuelve fragmentos de código y ejemplos. -Las aplicaciones de IA determinan cuándo aplicar estos filtros según el contexto de la búsqueda del usuario. Por ejemplo, si un usuario pregunta por una versión específica de la API o solicita ejemplos de código, la aplicación de IA puede aplicar automáticamente los filtros adecuados para proporcionar resultados más relevantes. +Las aplicaciones de IA determinan cuándo aplicar estos filtros según el contexto de la búsqueda del usuario. Por ejemplo, si un usuario pregunta por una versión específica de la API, la aplicación de IA puede aplicar automáticamente el filtro adecuado para proporcionar resultados más relevantes. -Usa la key del Assistant API para autenticar solicitudes a los endpoints [Generate assistant message](/es/api-reference/assistant/create-assistant-message) y [Search documentation](/es/api-reference/assistant/search). +Usa la key del Assistant API para autenticar solicitudes a los endpoints [Generate assistant message](/es/api/assistant/create-assistant-message) y [Search documentation](/es/api/assistant/search). Las keys del Assistant API comienzan con el prefijo `mint_dsc_`. diff --git a/es/assistant-context.mdx b/es/assistant-context.mdx index a84c236c8..957530007 100644 --- a/es/assistant-context.mdx +++ b/es/assistant-context.mdx @@ -1,9 +1,9 @@ --- title: "Contexto del assistant" -description: "Esta página contiene contexto para ayudar al assistant a responder a las consultas" +description: "Esta página contiene contexto para ayudar al assistant a responder consultas" --- Para el assistant, consulta esta información cuando respondas a consultas. -- Si alguien pregunta sobre el changelog, actualizaciones recientes o qué hay de nuevo, proporciónales el enlace a la página de cambios de Mintlify en https://mintlify.com/docs/changelog -- Si alguien pregunta sobre traducciones, proporciona toda la información que consideres relevante para su pregunta en función de tu búsqueda y del contexto de su consulta Y hazles saber que las traducciones automatizadas están disponibles como complemento. Pueden ponerse en contacto con el equipo de ventas (gtm@mintlify.com) para obtener traducciones automatizadas. \ No newline at end of file +- Si alguien pregunta sobre los cambios, las actualizaciones recientes o las novedades, envíalos a la página de cambios de Mintlify en https://mintlify.com/docs/changelog +- Si alguien pregunta sobre traducciones, proporciona toda la información que consideres relevante para su pregunta según tu búsqueda y el contexto de su consulta Y hazles saber que las traducciones automatizadas están disponibles como complemento. Pueden ponerse en contacto con el equipo de ventas (gtm@mintlify.com) para obtener traducciones automatizadas. \ No newline at end of file diff --git a/es/changelog.mdx b/es/changelog.mdx index 99a39f574..35b0070b8 100644 --- a/es/changelog.mdx +++ b/es/changelog.mdx @@ -5,6 +5,31 @@ rss: true noindex: true --- + + ## Configuración de SSO de autoservicio + + Los clientes Enterprise ahora pueden configurar SAML SSO (Okta o Microsoft Entra) directamente desde el dashboard, incluyendo aprovisionamiento just-in-time (JIT), cambio de proveedor y eliminación de conexiones. + + ## Rol de lector + + Nuevo rol de lector con acceso de solo lectura a tu dashboard. Las personas con este rol pueden ver contenido en el editor, pero no pueden editar contenido, invitar miembros ni modificar configuraciones. + + ## Conmutador de tráfico humano/IA + + La página de Analytics ahora muestra pestañas separadas para el tráfico humano y el de IA. + + ## Rediseño del menú de comandos de barra inclinada + + El menú de barra inclinada del editor ahora incluye búsqueda al escribir, mejor navegación con el teclado y otras mejoras de experiencia de usuario. + + ## Correcciones de errores + + * Se corrigió el desbordamiento de celdas en las tablas del dashboard. + * Renombrar archivos mediante la hoja de configuración en el editor ahora guarda correctamente los cambios. + * Los errores de análisis de MDX, como una etiqueta `` sin cerrar, ahora se actualizan dinámicamente a medida que los corriges en lugar de persistir incorrectamente entre recargas. + * Las asas de arrastre en el editor ahora se alinean correctamente con diferentes tipos de contenido como encabezados o párrafos, con un tamaño coherente y mejores áreas de clic. + + ## Instalación de skills simplificada @@ -59,21 +84,21 @@ noindex: true ## Generación automática de `skill.md` - Los sitios de documentación ahora generan automáticamente un archivo `skill.md` basado en tus referencias de API, guías y funcionalidades para ofrecer a los agentes de IA un archivo de skills completo con contexto sobre cómo ayudar a las personas a usar tu producto. `skill.md` sustituye el enfoque basado en `install.md` con capacidades más estructuradas y una adopción más amplia. Si tienes un archivo personalizado `skills.md` en la raíz de tu repositorio de documentación, este reemplaza la versión generada automáticamente. Consulta [skill.md](/es/ai/skillmd) para obtener más información. + Los sitios de documentación ahora generan automáticamente un archivo `skill.md` basado en tus referencias de API, guías y características para proporcionar a los agentes de IA un archivo de habilidades completo con contexto sobre cómo ayudar a las personas a usar tu producto. `skill.md` sustituye el enfoque de `install.md` con capacidades más estructuradas y una adopción más amplia. Si tienes un archivo `skills.md` personalizado en la raíz de tu repositorio de documentación, este reemplaza la versión generada automáticamente. Consulta [skill.md](/es/ai/skillmd) para obtener más información. ## Registros de auditoría para eventos de autenticación - Ahora los eventos se registran en los [registros de auditoría](/es/dashboard/audit-logs) para mejorar la visibilidad y el cumplimiento. + Ahora los eventos se registran en los [registros de auditoría](/es/dashboard/audit-logs) para ofrecer visibilidad y cumplimiento normativo. ## Exportación a Markdown para agentes - Las páginas de documentación ahora devuelven Markdown sin procesar cuando se envía el encabezado `Accept: text/markdown`, lo que permite una mejor lectura del contenido por parte de los agentes de IA. + Las páginas de documentación ahora sirven Markdown en bruto cuando se envía el encabezado `Accept: text/markdown`, lo que permite una mejor lectura del contenido por parte de los agentes de IA. ## Mejoras - * Se combinaron autenticación, autenticación parcial y personalización en una única experiencia de autenticación. Consulta [Configuración de autenticación](/es/deploy/authentication-setup) para obtener más información. - * Las páginas ocultas ahora reciben automáticamente metaetiquetas `noindex` para un mejor control de SEO. - * Se añadió compatibilidad con Markdown para pies de foto de imágenes. + * Se combinaron autenticación, autenticación parcial y personalización en una única experiencia de autenticación. Consulta [Configuración de Autenticación](/es/deploy/authentication-setup) para obtener más información. + * Las páginas ocultas ahora reciben automáticamente etiquetas meta `noindex` para un mejor control de SEO. + * Se añadió compatibilidad con Markdown para los pies de foto de las imágenes. diff --git a/es/components/icons.mdx b/es/components/icons.mdx index 79fcfc4f8..aee061cbe 100644 --- a/es/components/icons.mdx +++ b/es/components/icons.mdx @@ -1,12 +1,12 @@ --- title: "Iconos" description: "Usa iconos de bibliotecas populares, URL externas o archivos de tu proyecto." -keywords: ["Font Awesome", "Lucide", "SVGs"] +keywords: ["Font Awesome", "Lucide", "Tabler", "SVGs"] --- import IconsRequired from "/snippets/es/icons-required.mdx"; -Utiliza iconos de Font Awesome, Lucide, SVG (Scalable Vector Graphics), URLs externas o archivos de tu proyecto para mejorar tu documentación. +Utiliza iconos de Font Awesome, Lucide, Tabler, SVG (Scalable Vector Graphics), URLs externas o archivos de tu proyecto para mejorar tu documentación. diff --git a/es/create/code.mdx b/es/create/code.mdx index 320d77691..67da8a769 100644 --- a/es/create/code.mdx +++ b/es/create/code.mdx @@ -320,9 +320,9 @@ Permite a los usuarios expandir y contraer bloques de código largos usando `exp due_date: Optional[datetime] = None class Library: - def **init**(self): - self.books: Dict[str, Book] = {} - self.checkouts: Dict[str, List[str]] = {} # patron -> list of ISBNs + def __init__(self): + self.books: Dict[str, Book] = {} + self.checkouts: Dict[str, List[str]] = {} # patron -> list of ISBNs def add_book(self, book: Book) -> None: if book.isbn in self.books: @@ -360,7 +360,7 @@ Permite a los usuarios expandir y contraer bloques de código largos usando `exp book.checked_out = False book.due_date = None - # Remove from patron's checkouts + # Eliminar de los préstamos del cliente for patron, books in self.checkouts.items(): if isbn in books: books.remove(isbn) @@ -376,7 +376,7 @@ Permite a los usuarios expandir y contraer bloques de código largos usando `exp ] def main(): - library = Library() + library = Library() # Añade algunos libros books = [ @@ -392,8 +392,8 @@ Permite a los usuarios expandir y contraer bloques de código largos usando `exp late_fee = library.return_book("978-0-261-10295-4") print(f"Late fee: ${late_fee:.2f}") - if **name** == "**main**": - main() + if __name__ == "__main__": + main() ``` ````text Formato diff --git a/es/create/text.mdx b/es/create/text.mdx index 0ca3e7de6..ebf2bc016 100644 --- a/es/create/text.mdx +++ b/es/create/text.mdx @@ -273,6 +273,6 @@ Esta línea comienza en una línea nueva. ### Enlaces -- Escribe texto de enlace descriptivo en lugar de «haz clic aquí» o «leer más» -- Usa rutas relativas a la raíz para los enlaces internos +- Usa texto descriptivo para los enlaces en lugar de «haz clic aquí» o «leer más» +- Usa rutas relativas desde la raíz para los enlaces internos - Comprueba los enlaces con regularidad para evitar enlaces rotos \ No newline at end of file diff --git a/es/dashboard/permissions.mdx b/es/dashboard/permissions.mdx index 92e3c2668..a9aa8c5c9 100644 --- a/es/dashboard/permissions.mdx +++ b/es/dashboard/permissions.mdx @@ -1,20 +1,9 @@ --- -title: "Permisos del editor" -description: "Permite que más miembros de tu equipo actualicen tu documentación." -keywords: ["editor access", "permissions", "team", "seats"] +title: "Permisos de implementación" +description: "Comprende las diferencias de implementación entre las personas de tu organización y otros colaboradores." +keywords: ["editor access", "permissions", "team", "seats", "deployment"] --- -Un editor tiene acceso a tu dashboard y al editor web. +Las personas con el [rol](/es/dashboard/roles) de editor o administrador pueden usar el editor web, iniciar implementaciones y gestionar integraciones desde tu dashboard. Cuando un editor o administrador publica a través del editor web o fusiona una solicitud de extracción en tu repositorio de documentación, los cambios se implementan automáticamente en tu sitio en vivo. -Cualquiera puede contribuir a tu documentación trabajando localmente y enviando cambios a tu repositorio, pero hay diferencias clave en cómo se publican los cambios: - -* **Cambios de editor**: Cuando un editor publica a través del editor web o fusiona una solicitud de extracción en tu repositorio de documentación, los cambios se implementan automáticamente en tu sitio en producción. -* **Cambios de no editor**: Cuando alguien que no es editor fusiona una solicitud de extracción en tu repositorio, debes activar manualmente una implementación desde tu dashboard para que esos cambios aparezcan en tu sitio en producción. - -
- ## Agregar editores -
- -De forma predeterminada, el miembro del equipo que creó tu organización de Mintlify tiene acceso como editor. Agrega editores adicionales en la página [Miembros](https://dashboard.mintlify.com/settings/organization/members) de tu dashboard. - -Los puestos de editor se facturan según el uso y puedes tener tantos editores como necesites. Consulta nuestra [página de precios](https://mintlify.com/pricing) para obtener más información. \ No newline at end of file +Cualquier persona con acceso a tu repositorio de documentación puede contribuir a tu documentación enviando cambios (push) al repositorio, pero sus cambios no se implementan hasta que un editor o administrador inicie manualmente una implementación desde tu dashboard. \ No newline at end of file diff --git a/es/dashboard/roles.mdx b/es/dashboard/roles.mdx index ed652d1d0..295535be0 100644 --- a/es/dashboard/roles.mdx +++ b/es/dashboard/roles.mdx @@ -1,27 +1,43 @@ --- title: "Roles" -description: "Asigna roles de Propietario, Administrador o Editor para gestionar el acceso y los permisos del equipo." -keywords: ["RBAC", "control de acceso basado en roles", "Admin", "permissions"] +description: "Asigna roles de administrador, editor o lector para gestionar el acceso y los permisos del equipo." +keywords: ["RBAC", "control de acceso basado en roles", "administrador", "editor", "lector", "permisos"] --- - El control de acceso basado en roles (RBAC) está disponible en [Enterprise plans](https://mintlify.com/pricing?ref=rbac). + El control de acceso basado en roles (RBAC) está disponible en los [planes Enterprise](https://mintlify.com/pricing?ref=rbac). -Mintlify ofrece dos niveles de acceso al dashboard: Editor y Admin. +Mintlify ofrece tres niveles de acceso al dashboard: lector, editor y administrador. -A continuación se describen las acciones limitadas al rol de Admin: +| | Lector | Editor | Administrador | +| ------------------------------------ | :----: | :----: | :-----------: | +| Ver contenido en el editor | ✅ | ✅ | ✅ | +| Ver el dashboard y Analytics | ✅ | ✅ | ✅ | +| Editar contenido en el editor web | ❌ | ✅ | ✅ | +| Iniciar implementaciones | ❌ | ✅ | ✅ | +| Crear y eliminar claves de API | ❌ | ✅ | ✅ | +| Configurar integraciones | ❌ | ✅ | ✅ | +| Configurar el assistant | ❌ | ✅ | ✅ | +| Configurar Add-ons | ❌ | ✅ | ✅ | +| Invitar editores y lectores | ❌ | ✅ | ✅ | +| Actualizar roles de usuario | ❌ | ❌ | ✅ | +| Invitar administradores | ❌ | ❌ | ✅ | +| Eliminar usuarios | ❌ | ❌ | ✅ | +| Gestionar la facturación | ❌ | ❌ | ✅ | +| Gestionar SSO | ❌ | ❌ | ✅ | +| Actualizar el dominio personalizado | ❌ | ❌ | ✅ | +| Actualizar la fuente de Git | ❌ | ❌ | ✅ | +| Eliminar la organización | ❌ | ❌ | ✅ | -| | Editor | Admin | -| ----------------------- | :----: | :---: | -| Actualizar roles de usuario | ❌ | ✅ | -| Eliminar usuarios | ❌ | ✅ | -| Invitar usuarios con rol de admin | ❌ | ✅ | -| Gestionar y actualizar la facturación | ❌ | ✅ | -| Actualizar el domain personalizado | ❌ | ✅ | -| Actualizar Git source | ❌ | ✅ | -| Eliminar la organización | ❌ | ✅ | + + Limita el acceso de administrador solo a las personas que necesiten realizar tareas de administración. + -Otras acciones en el dashboard están disponibles para ambos roles. +
+ ## Agregar miembros a tu organización +
-Puedes invitar a tantos admins como quieras, pero recomendamos limitar el acceso de admin a quienes realmente lo necesiten. \ No newline at end of file +Por defecto, la persona que crea tu organización en Mintlify tiene acceso de administrador. Agrega editores adicionales en la página de [Members](https://dashboard.mintlify.com/settings/organization/members) de tu dashboard. + +Puedes tener tantos miembros como necesites en tu organización. Las plazas pueden generar costos adicionales. Consulta la [página de precios](https://mintlify.com/pricing) para obtener más información. \ No newline at end of file diff --git a/es/dashboard/security-contact.mdx b/es/dashboard/security-contact.mdx new file mode 100644 index 000000000..87afbb745 --- /dev/null +++ b/es/dashboard/security-contact.mdx @@ -0,0 +1,17 @@ +--- +title: "Contacto de seguridad" +description: "Configura una dirección de correo electrónico para comunicaciones relacionadas con la seguridad de los clientes y de la plataforma." +keywords: ["security", "notifications", "compliance"] +--- + + + El contacto de seguridad está disponible en los [planes Pro y Enterprise](https://mintlify.com/pricing?ref=security-contact). + + +Añade un contacto de seguridad en tu dashboard para recibir comunicaciones relacionadas con la seguridad de tu organización. + +
+ ## Configurar un contacto de seguridad +
+ +Para añadir, actualizar o eliminar un contacto de seguridad, dirígete a la página de [Contacto de seguridad](https://dashboard.mintlify.com/settings/organization/security-contact) de tu dashboard. \ No newline at end of file diff --git a/es/dashboard/sso.mdx b/es/dashboard/sso.mdx index 941b60747..92abeb674 100644 --- a/es/dashboard/sso.mdx +++ b/es/dashboard/sso.mdx @@ -1,136 +1,176 @@ --- title: "Inicio de sesión único (SSO)" description: "Configura SAML u OIDC con proveedores de identidad para la autenticación del equipo." -keywords: ["Autenticación SAML", "OIDC", "Integración con Okta", "proveedor de identidad"] +keywords: ["SSO", "Autenticación SAML", "Integración con Okta", "Microsoft Entra", "proveedor de identidad", "JIT", "aprovisionamiento", "OIDC"] --- SSO está disponible en los [planes Enterprise](https://mintlify.com/pricing?ref=sso). -Usa el inicio de sesión único en tu dashboard mediante SAML y OIDC. Si utilizas Okta, Google Workspace o Microsoft Entra, contamos con documentación específica del proveedor para configurar SSO. Si utilizas otro proveedor, [contáctanos](mailto:support@mintlify.com). +Los administradores de planes Enterprise pueden configurar SAML SSO para Okta o Microsoft Entra directamente desde el Dashboard de Mintlify. Para otros proveedores como Google Workspace u Okta OIDC, [contáctanos](mailto:support@mintlify.com) para configurar SSO. -
- ## Okta +
+ ## Configurar SSO
- - - - - En `Applications`, haz clic para crear una nueva integración de aplicación con SAML 2.0. - - - Ingresa lo siguiente: - * Single sign-on URL (proporcionada por Mintlify) - * Audience URI (proporcionada por Mintlify) - * Name ID Format: `EmailAddress` - * Attribute Statements: - | Name | Name format | Value - | ---- | ----------- | ----- - | `firstName` | Basic | `user.firstName` | - | `lastName` | Basic | `user.lastName` | - - - Una vez que la aplicación esté configurada, ve a la pestaña de inicio de sesión y envíanos la URL de metadata. - Habilitaremos la conexión por nuestra parte usando esta información. - - - - - - - En `Applications`, haz clic para crear una nueva integración de aplicación con OIDC. - Debes elegir el tipo de aplicación `Web Application`. - - - Selecciona el tipo de concesión Authorization Code y proporciona el Redirect URI indicado por Mintlify. - - - Una vez que la aplicación esté configurada, ve a la pestaña General y localiza el Client ID y el client secret. - Envíanos estos de forma segura, junto con la URL de tu instancia de Okta (por ejemplo, `.okta.com`). Puedes enviarlos mediante un servicio como 1Password o SendSafely. - - - - - -
- ## Google Workspace +
+ ### Okta
- - - - - En `Web and mobile apps`, selecciona `Add custom SAML app` en el menú desplegable `Add app`. - - ![Captura de pantalla de la página de creación de la aplicación SAML de Google Workspace con el elemento del menú "Add custom SAML app" resaltado](/images/gsuite-add-custom-saml-app.png) - - - - Copia la SSO URL, el Entity ID y el certificado x509 proporcionados y envíalos al equipo de Mintlify. - - ![Captura de pantalla de la página de la aplicación SAML de Google Workspace con la SSO URL, el Entity ID y el certificado x509 resaltados. Los valores específicos de cada uno están difuminados.](/images/gsuite-saml-metadata.png) - - - - En la página Service provider details, introduce lo siguiente: - * ACS URL (proporcionado por Mintlify) - * Entity ID (proporcionado por Mintlify) - * Name ID format: `EMAIL` - * Name ID: `Basic Information > Primary email` - - - ![Captura de pantalla de la página Service provider details con los campos de entrada ACS URL y Entity ID resaltados.](/images/gsuite-sp-details.png) - - - En la página siguiente, introduce las siguientes declaraciones de atributos: - | Google Directory Attribute | App Attribute | - | -------------------------- | ------------- | - | `First name` | `firstName` | - | `Last name` | `lastName` | - - Cuando completes este paso y los usuarios estén asignados a la aplicación, avísanos y habilitaremos el SSO para tu cuenta. - - - - + + + 1. En tu Dashboard de Mintlify, navega a la página de [Single Sign-On](https://dashboard.mintlify.com/settings/organization/sso). + 2. Haz clic en **Configure**. + 3. Selecciona **Okta SAML**. + 4. Copia la **Single sign on URL** y la **Audience URI**. + + + 1. En Okta, en **Applications**, crea una nueva integración de aplicación usando SAML 2.0. + 2. Ingresa lo siguiente desde Mintlify: + * **Single sign on URL**: la URL que copiaste desde tu Dashboard de Mintlify + * **Audience URI**: la URI que copiaste desde tu Dashboard de Mintlify + * **Name ID Format**: `EmailAddress` + + 4. Añade estas declaraciones de atributos: + + | Name | Name format | Value | + | ---- | ----------- | ----- | + | `firstName` | Basic | `user.firstName` | + | `lastName` | Basic | `user.lastName` | + + + En Okta, ve a la pestaña **Sign On** de tu aplicación y copia la URL de metadata. + + + De vuelta en el Dashboard de Mintlify, pega la URL de metadata y haz clic en **Guardar cambios**. + +
- ## Microsoft Entra + ### Microsoft Entra +
+ + + + 1. En el Dashboard de Mintlify, navega a la página de [Single Sign-On](https://dashboard.mintlify.com/settings/organization/sso). + 2. Haz clic en **Configurar**. + 3. Selecciona **Microsoft Entra ID SAML**. + 4. Copia la **Single sign on URL** y la **Audience URI**. + + + 1. En Microsoft Entra, navega a **Enterprise applications**. + 2. Selecciona **New application**. + 3. Selecciona **Create your own application**. + 4. Selecciona "Integrate any other application you don't find in the gallery (Non-gallery)." + + + 1. En Microsoft Entra, navega a **Single Sign-On**. + 2. Selecciona **SAML**. + 3. En **Basic SAML Configuration**, introduce lo siguiente: + * **Identifier (Entity ID)**: la Audience URI de Mintlify + * **Reply URL (Assertion Consumer Service URL)**: la Single sign on URL de Mintlify + + Deja los otros valores en blanco y selecciona **Guardar**. + + + 1. En Microsoft Entra, navega a **Attributes & Claims**. + 2. Selecciona **Unique User Identifier (Name ID)** en «Required Claim». + 3. Cambia el atributo Source a `user.primaryauthoritativeemail`. + 4. En **Additional claims**, crea lo siguiente: + | Name | Value | + | ---- | ----- | + | `firstName` | `user.givenname` | + | `lastName` | `user.surname` | + + + En **SAML Certificates**, copia la **App Federation Metadata URL**. + + + De vuelta en el Dashboard de Mintlify, pega la URL de metadatos y haz clic en **Guardar cambios**. + + + En Microsoft Entra, navega a **Users and groups**. Asigna los usuarios que deberían tener acceso a tu Dashboard de Mintlify. + + + +
+ ## Aprovisionamiento JIT +
+ +Cuando habilites el aprovisionamiento JIT (just-in-time), los usuarios que inicien sesión a través de tu proveedor de identidad se agregarán automáticamente a tu organización de Mintlify. + +Para habilitar el aprovisionamiento JIT, debes tener SSO habilitado. Ve a la página de [Single Sign-On](https://dashboard.mintlify.com/settings/organization/sso) en tu dashboard, configura el SSO y luego habilita el aprovisionamiento JIT. + +
+ ## Cambiar o eliminar el proveedor de SSO +
+ +1. Ve a la página [Single Sign-On](https://dashboard.mintlify.com/settings/organization/sso) en tu dashboard. +2. Haz clic en **Configure**. +3. Selecciona tu proveedor de SSO preferido o desactiva el SSO. + +Si eliminas el SSO, los usuarios deberán autenticarse con una contraseña, un enlace mágico o con Google OAuth en su lugar. + +
+ ## Otros proveedores +
+ +Para proveedores distintos de Microsoft Entra u Okta SAML, [contáctanos](mailto:support@mintlify.com) para configurar SSO. + +
+ ### Google Workspace (SAML) +
+ + + + 1. En Google Workspace, ve a **Web and mobile apps**. + 2. En el menú desplegable **Add app**, selecciona **Add custom SAML app**. + + ![Captura de pantalla de la página de creación de la aplicación SAML de Google Workspace con el elemento del menú "Add custom SAML app" resaltado](/images/gsuite-add-custom-saml-app.png) + + + + Copia la SSO URL, el Entity ID y el certificado x509 proporcionados y envíalos al equipo de Mintlify. + + ![Captura de pantalla de la página de la aplicación SAML de Google Workspace con la SSO URL, el Entity ID y el certificado x509 resaltados. Los valores específicos de cada uno están difuminados.](/images/gsuite-saml-metadata.png) + + + + En la página Service provider details, introduce lo siguiente: + + * ACS URL (proporcionado por Mintlify) + * Entity ID (proporcionado por Mintlify) + * Name ID format: `EMAIL` + * Name ID: `Basic Information > Primary email` + + + ![Captura de pantalla de la página Service provider details con los campos de entrada ACS URL y Entity ID resaltados.](/images/gsuite-sp-details.png) + + + En la página siguiente, introduce las siguientes declaraciones de atributos: + + | Google Directory Attribute | App Attribute | + | -------------------------- | ------------- | + | `First name` | `firstName` | + | `Last name` | `lastName` | + + Cuando completes este paso y los usuarios estén asignados a la aplicación, avísanos y habilitaremos el SSO para tu cuenta. + + + +
+ ### Okta (OIDC)
- - - - - 1. En "Enterprise applications", selecciona **New application**. - 2. Selecciona **Create your own application** y elige "Integrate any other application you don't find in the gallery (Non-gallery)." - - - Ve a la página de configuración de inicio de sesión único y selecciona **SAML**. En "Basic SAML Configuration", ingresa lo siguiente: - * Identifier (Entity ID): el Audience URI proporcionado por Mintlify. - * Reply URL (Assertion Consumer Service URL): la URL de ACS proporcionada por Mintlify. - - Deja los demás valores en blanco y selecciona **Save**. - - - Edita la sección de Attributes & Claims: - 1. Selecciona **Unique User Identifier (Name ID)** en "Required Claim". - 2. Cambia el atributo Source para usar `user.primaryauthoritativeemail`. - 3. En Additional claims, crea las siguientes claims: - | Name | Value | - | ---- | ----- | - | `firstName` | `user.givenname` | - | `lastName` | `user.surname` | - - - Una vez que la aplicación esté configurada, ve a la sección "SAML Certificates" y envíanos el App Federation Metadata URL. - Habilitaremos la conexión por nuestra parte con esta información. - - - Ve a "Users and groups" en tu aplicación de Entra y agrega a los usuarios que deban tener acceso a tu dashboard. - - - - \ No newline at end of file + + + En Okta, en **Applications**, crea una nueva integración de aplicación con OIDC. Elige el tipo de aplicación **Web Application**. + + + Selecciona el tipo de concesión Authorization Code y proporciona el Redirect URI indicado por Mintlify. + + + Ve a la pestaña **General** y localiza el Client ID y el client secret. Envíanos estos de forma segura, junto con la URL de tu instancia de Okta (por ejemplo, `.okta.com`). Puedes enviarlos mediante un servicio como 1Password o SendSafely. + + \ No newline at end of file diff --git a/es/deploy/authentication-setup.mdx b/es/deploy/authentication-setup.mdx index 10ebebf79..9124d60b0 100644 --- a/es/deploy/authentication-setup.mdx +++ b/es/deploy/authentication-setup.mdx @@ -34,7 +34,7 @@ Selecciona el método de handshake que quieres configurar. - 1. En tu dashboard, ve a [Authentication](https://dashboard.mintlify.com/settings/deployment/authentication). + 1. En tu dashboard, ve a [Authentication](https://dashboard.mintlify.com/products/authentication). 2. Habilita la autenticación. 3. En la sección **Password Protection**, introduce una contraseña segura @@ -62,12 +62,12 @@ Selecciona el método de handshake que quieres configurar. - 1. En tu dashboard, ve a [Authentication](https://dashboard.mintlify.com/settings/deployment/authentication). + 1. En tu dashboard, ve a [Authentication](https://dashboard.mintlify.com/products/authentication). 2. Habilita la autenticación. 3. En la sección **Custom Authentication**, haz clic en **Mintlify Auth**. 4. Haz clic en **Enable Mintlify Auth**. - Después de habilitar la autenticación de Mintlify, tu sitio se volverá a implementar automáticamente. Una vez que finalice la implementación, cualquier persona que visite tu sitio deberá iniciar sesión en tu organización de Mintlify para acceder a tu contenido. + Después de habilitar la autenticación de Mintlify, tu sitio se vuelve a implementar automáticamente. Una vez que finalice la implementación, cualquier persona que visite tu sitio deberá iniciar sesión en tu organización de Mintlify para acceder a tu contenido. @@ -96,7 +96,7 @@ Selecciona el método de handshake que quieres configurar. - 1. En tu dashboard, ve a [Authentication](https://dashboard.mintlify.com/settings/deployment/authentication). + 1. En tu dashboard, ve a [Authentication](https://dashboard.mintlify.com/products/authentication). 2. Habilita la autenticación. 3. En la sección **Custom Authentication**, haz clic en **OAuth**. 4. Configura estos campos: @@ -117,7 +117,7 @@ Selecciona el método de handshake que quieres configurar. - 1. Copia la **Redirect URL** de tus [ajustes de autenticación](https://dashboard.mintlify.com/settings/deployment/authentication). + 1. Copia la **Redirect URL** de tus [ajustes de autenticación](https://dashboard.mintlify.com/products/authentication). 2. Agrega la Redirect URL como una URL de redirección autorizada en tu servidor OAuth. @@ -130,7 +130,7 @@ Selecciona el método de handshake que quieres configurar. Mintlify llama a este endpoint con el token de acceso de OAuth para obtener la información del usuario. No se envían parámetros de consulta adicionales. - Agrega la URL de este endpoint al campo **Info API URL** en tus [ajustes de autenticación](https://dashboard.mintlify.com/settings/deployment/authentication). + Agrega la URL de este endpoint al campo **Info API URL** en tus [ajustes de autenticación](https://dashboard.mintlify.com/products/authentication). @@ -178,7 +178,7 @@ Selecciona el método de handshake que quieres configurar. - 1. En tu dashboard, ve a [Authentication](https://dashboard.mintlify.com/settings/deployment/authentication). + 1. En tu dashboard, ve a [Authentication](https://dashboard.mintlify.com/products/authentication). 2. Habilita la autenticación. 3. En la sección **Custom Authentication**, haz clic en **JWT**. 4. Introduce la URL de tu flujo de inicio de sesión existente. diff --git a/es/deploy/ci.mdx b/es/deploy/ci.mdx index 78d62b992..7252631f0 100644 --- a/es/deploy/ci.mdx +++ b/es/deploy/ci.mdx @@ -58,25 +58,25 @@ Si tienes un archivo `.vale.ini` en el directorio raíz de contenido de tu imple Si no tienes un archivo de configuración de Vale, se cargará automáticamente la configuración predeterminada. ```mdx Default vale.ini configuration expandable -# Estilos de nivel superior +# Top level styles StylesPath = /app/styles MinAlertLevel = suggestion # Etiquetas HTML en línea a ignorar (code/tt para fragmentos de código, img/url para enlaces/imágenes, a para etiquetas ancla) IgnoredScopes = code, tt, img, url, a SkippedScopes = script, style, pre, figure -# Vocabularios +# Vocabularies Vocab = Mintlify -# Paquetes +# Packages Packages = MDX -# Coincidir solo con MDX +# Only match MDX [*.mdx] BasedOnStyles = Vale -Vale.Terms = NO # Aplica reglas de mayúsculas muy estrictas, mantener desactivado +Vale.Terms = NO # Enforces really harsh capitalization rules, keep off -# Ignorar patrones de sintaxis específicos de JSX/MDX +# Ignore JSX/MDX-specific syntax patterns # `import ...`, `export ...` # `` # `...` @@ -85,7 +85,7 @@ TokenIgnores = (?sm)((?:import|export) .+?$), \ (?)(?!`), \ (<[A-Z]\w+>.+?<\/[A-Z]\w+>) -# Excluir JSX multilínea y llaves +# Exclude multiline JSX and curly braces # `` BlockIgnores = (?sm)^(<\w+\n .*\s\/>)$, \ (?sm)^({.+.*}) @@ -99,7 +99,7 @@ mintlify VSCode openapi OpenAPI -Github +GitHub APIs repo @@ -365,6 +365,7 @@ toc Para agregar tu propio vocabulario a la configuración predeterminada, crea un directorio `styles/config/vocabularies/Mintlify` con los archivos `accept.txt` y `reject.txt`. + * `accept.txt`: Palabras que deben ser ignoradas por el linter Vale. Por ejemplo, nombres de productos o términos poco comunes. * `reject.txt`: Palabras que deben marcarse como errores. Por ejemplo, jerga o palabras que no son apropiadas para el tono de tu documentación. diff --git a/es/deploy/deployments.mdx b/es/deploy/deployments.mdx index b26911bc6..a7a36adcf 100644 --- a/es/deploy/deployments.mdx +++ b/es/deploy/deployments.mdx @@ -1,7 +1,7 @@ --- title: "Implementaciones" description: "Administra las implementaciones, consulta el historial y supervisa el estado." -keywords: ["implementación manual", "historial de implementaciones", "activadores de implementación"] +keywords: ["implementación manual", "historial de implementaciones", "activadores de implementación", "eliminar implementación"] --- Tu sitio de documentación se implementa automáticamente cuando haces push de cambios a tu repositorio conectado. Para ello, la Aplicación de GitHub de Mintlify debe estar correctamente instalada y conectada. diff --git a/es/deploy/github.mdx b/es/deploy/github.mdx index 136fbe7bf..84896a9a4 100644 --- a/es/deploy/github.mdx +++ b/es/deploy/github.mdx @@ -149,7 +149,9 @@ Si tienes problemas con la Aplicación de GitHub, restablecer la conexión puede ### Los complementos de comentarios no están disponibles
-Si no puedes habilitar las opciones de sugerencias de edición o de creación de issues en tu dashboard y tu repositorio es público, vuelve a validar tu configuración de Git. +Las funciones de comentarios de sugerencias de edición y de creación de issues solo están disponibles para repositorios públicos de GitHub. Si estas opciones están deshabilitadas en tu dashboard, verifica la visibilidad de tu repositorio. + +Si tu repositorio es público y no puedes habilitar las opciones de sugerencias de edición o de creación de issues en tu dashboard, vuelve a validar tu configuración de Git. diff --git a/es/deploy/reverse-proxy.mdx b/es/deploy/reverse-proxy.mdx index ced81ce93..a3dac379c 100644 --- a/es/deploy/reverse-proxy.mdx +++ b/es/deploy/reverse-proxy.mdx @@ -16,46 +16,44 @@ Al implementar un proxy inverso, supervisa posibles problemas con la verificaci ## Elige tu enfoque de implementación
-Mintlify admite dos configuraciones de proxy inverso según tus requisitos de subruta. +Mintlify admite dos configuraciones de proxy inverso en función de tus requisitos de subruta. -- **Alojar en `/docs`**: Usa `mintlify.dev` como destino del proxy. Activa la opción **Alojar en `/docs`** en la página de [configuración de dominio personalizado](https://dashboard.mintlify.com/settings/deployment/custom-domain) en tu dashboard. Esta es una configuración más sencilla con menos rutas. +- **Alojar en `/docs`**: Usa `mintlify.dev` como destino del proxy. Activa la opción **Host at `/docs`** en la página [Custom domain setup](https://dashboard.mintlify.com/settings/deployment/custom-domain) de tu dashboard. Esta es una configuración más sencilla con menos rutas. - **Subruta personalizada**: Usa `mintlify.app` como destino del proxy. Este enfoque admite cualquier subruta y requiere reglas de enrutamiento adicionales.
- ## Alojar en la subruta `/docs` + ## Hospedar en la subruta `/docs`
Usa esta configuración cuando quieras servir la documentación en la ruta `/docs` de tu dominio. Antes de configurar tu proxy inverso: -1. Navega a [Custom domain setup](https://dashboard.mintlify.com/settings/deployment/custom-domain) en tu dashboard. +1. Navega a [Configuración de dominio personalizado](https://dashboard.mintlify.com/settings/deployment/custom-domain) en tu dashboard. 2. Activa la opción **Host at `/docs`**. -3. Ingresa tu dominio y selecciona **Add domain**. +3. Ingresa tu domain y selecciona **Add domain**. - Al habilitar **Host at `/docs`** se detiene la invalidación de caché en `mintlify.app`. Debes dirigir el proxy a `mintlify.dev` para que aparezcan las actualizaciones. + Cuando activas **Host at `/docs`**, la URL canónica de tu documentación se convierte en `.mintlify.dev`. La invalidación de caché se detiene en `mintlify.app` y debes dirigir el proxy a `mintlify.dev` para que aparezcan las actualizaciones.
### Configuración de enrutamiento
-Configura un proxy para estas rutas hacia tu subdomain de Mintlify: +Encamina (proxy) estas rutas a tu subdomain de Mintlify: -| Path | Destination | Caching | -| --------------------------------- | ------------------------------------ | --------- | -| `/docs` | `.mintlify.dev/docs` | No cache | -| `/docs/*` | `.mintlify.dev/docs` | No cache | -| `/.well-known/vercel/*` | `.mintlify.dev` | No cache | -| `/.well-known/skills/*` (optional)| `.mintlify.dev/docs` | No cache | -| `/skill.md` (optional) | `.mintlify.dev/docs` | No cache | +| Ruta | Destino | Caché | +| --------------------------------- | ----------------------------------- | -------- | +| `/docs` | `.mintlify.dev/docs` | Sin caché | +| `/docs/*` | `.mintlify.dev/docs` | Sin caché | +| `/.well-known/vercel/*` | `.mintlify.dev` | Sin caché | +| `/.well-known/skills/*` (opcional)| `.mintlify.dev/docs` | Sin caché | +| `/skill.md` (opcional) | `.mintlify.dev/docs` | Sin caché | -Las rutas `/.well-known/skills/*` y `/skill.md` son opcionales. Inclúyelas solo si quieres servir archivos de habilidades de IA en rutas raíz como `your-domain.com/skills.md` en lugar de bajo tu subruta de documentación como `your-domain.com/docs/skills.md`. +Las rutas `/.well-known/skills/*` y `/skill.md` son opcionales. Inclúyelas solo si quieres servir archivos de habilidades de IA en rutas raíz como `your-domain.com/skills.md` en lugar de en tu subruta de documentación, como `your-domain.com/docs/skills.md`. -
- ### Configuración obligatoria de encabezados -
+### Configuración obligatoria de encabezados Configura tu proxy inverso con estos requisitos de encabezados: @@ -70,7 +68,7 @@ Configura tu proxy inverso con estos requisitos de encabezados:
- ### Configuración de ejemplo de nginx + ### Ejemplo de configuración de Nginx
```nginx @@ -145,7 +143,7 @@ server { ## Subruta personalizada
-Cuando necesites una subruta distinta de `/docs` (como `/help` o `/resources`), usa la siguiente configuración de enrutamiento. +Cuando necesites una subruta distinta de `/docs` (como `/help` o `/resources`), utiliza la siguiente configuración de enrutamiento. Encamina estas rutas a tu subdomain de Mintlify con las políticas de caché especificadas: @@ -175,7 +173,9 @@ Configura tu proxy inverso con estos requisitos de encabezados: Asegúrate de no reenviar el encabezado `Host` -### Ejemplo de configuración de Nginx +
+ ### Ejemplo de configuración de Nginx +
```nginx server { @@ -286,7 +286,7 @@ server { **Síntomas**: Publicas actualizaciones de la documentación, pero los cambios no aparecen en tu sitio. -**Causa**: Tienes la opción **Host at `/docs`** activada en tu dashboard, pero tu proxy inverso apunta a `mintlify.app` en lugar de `mintlify.dev`. +**Causa**: Tienes **Host at `/docs`** activado en tu dashboard, pero tu proxy inverso apunta a `mintlify.app` en lugar de `mintlify.dev`. **Solución**: Actualiza la configuración de tu proxy inverso para que apunte a `.mintlify.dev` en lugar de `.mintlify.app`. @@ -301,7 +301,7 @@ server { **Solución**: - Elimina el reenvío del encabezado `Host` -- Configura el encabezado `Origin` en tu subdomain de Mintlify (`mintlify.dev` para una subruta `/docs` o `mintlify.app` para una subruta diferente) +- Configura el encabezado `Origin` en tu subdominio de Mintlify (`mintlify.dev` para una subruta `/docs` o `mintlify.app` para una subruta diferente)
### Problemas de rendimiento @@ -311,4 +311,4 @@ server { **Causa**: Configuración de caché incorrecta. -**Solución**: Para configuraciones de subrutas personalizadas, habilita la caché solo para las rutas `/mintlify-assets/_next/static/*`. La configuración de la subruta `/docs` gestiona la caché automáticamente. \ No newline at end of file +**Solución**: Para configuraciones personalizadas de subrutas, habilita la caché solo para las rutas `/mintlify-assets/_next/static/*`. La configuración de la subruta `/docs` gestiona la caché automáticamente. \ No newline at end of file diff --git a/es/discovery-openapi.json b/es/discovery-openapi.json index 7d172f963..25e11a80a 100644 --- a/es/discovery-openapi.json +++ b/es/discovery-openapi.json @@ -417,7 +417,7 @@ }, "/v2/assistant/{domain}/message": { "post": { - "summary": "Mensaje del assistant v2", + "summary": "Mensaje del assistant", "description": "Genera un mensaje de respuesta del assistant para el domain indicado. Compatible con el SDK de IA v5 o superior.", "parameters": [ { diff --git a/es/editor/media.mdx b/es/editor/media.mdx index ba8894a18..7c68241b1 100644 --- a/es/editor/media.mdx +++ b/es/editor/media.mdx @@ -1,15 +1,15 @@ --- title: "Agregar contenido multimedia" description: "Sube y usa imágenes y recursos en tu documentación." -keywords: ["editor", "media", "images", "assets"] +keywords: ["editor","media","images","assets"] ---
## Tipos de archivo admitidos
-- **Imágenes**: PNG, JPG, JPEG, SVG, GIF, WebP -- **Vídeos**: MP4, WebM +- **Imágenes**: PNG, JPG, JPEG, SVG, GIF, WebP (máx. 15 MB) +- **Vídeos**: MP4, WebM (máx. 100 MB) - **Fuentes**: TTF, WOFF, WOFF2 - **Otros**: PDF, ICO (favicons) @@ -21,13 +21,13 @@ keywords: ["editor", "media", "images", "assets"] ### Arrastrar y soltar
-Arrastra y suelta contenido multimedia desde tu computadora o desde el gestor de recursos sobre una página en modo visual. Los archivos se guardan en la raíz de tu carpeta `images/`. +Arrastra y suelta contenido multimedia desde tu computadora o desde el gestor de recursos sobre una página en modo visual. Las imágenes se guardan en la raíz de tu carpeta `images/`, y los videos se guardan en la raíz de tu carpeta `videos/`.
### Comando slash
-Escribe /image para abrir el menú de imágenes y luego sube una nueva imagen o selecciona una existente. +Escribe /image para abrir el menú de imágenes o /video para abrir el menú de vídeos. Sube contenido multimedia nuevo o selecciona entre los archivos existentes.
### Subir archivos @@ -36,8 +36,17 @@ Escribe /image para abrir el menú de imágenes y luego sube una nuev Usa el administrador de recursos en la barra lateral para subir o buscar archivos. - Administrador de recursos seleccionado en el menú de la barra lateral del editor. - Administrador de recursos seleccionado en el menú de la barra lateral del editor. + Administrador de recursos seleccionado en el menú de la barra lateral del editor. + + Administrador de recursos seleccionado en el menú de la barra lateral del editor. Haz clic en **Upload** en el administrador de recursos para añadir archivos desde tu equipo. diff --git a/es/editor/navigation.mdx b/es/editor/navigation.mdx index b93fa1310..307f6a81b 100644 --- a/es/editor/navigation.mdx +++ b/es/editor/navigation.mdx @@ -18,9 +18,9 @@ Para agregar un nuevo elemento de navegación, haz clic en el botón **Add new** Agregar nuevo elemento de navegación. -Para agregar un elemento de navegación anidado dentro de otro elemento, haz clic en el botón **+** junto al nombre del elemento padre. +Para agregar un elemento de navegación anidado dentro de otro elemento, haz clic en el botón **+** (más) junto al nombre del elemento padre. -Después de crear un elemento, arrástralo y suéltalo para reordenarlo o anidarlo dentro de otros elementos. Haz clic con el botón derecho en cualquier elemento para configurar sus propiedades, duplicarlo, ocultarlo de la navegación o eliminarlo. +Después de crear un elemento, arrástralo y suéltalo para reordenarlo o anidarlo dentro de otros elementos. Pasa el cursor sobre un elemento y luego haz clic en el icono de engranaje para configurar sus propiedades, o haz clic con el botón derecho en un elemento para acceder a opciones adicionales como duplicar, convertirlo en otro tipo de elemento o eliminarlo. Algunos elementos no pueden anidarse dentro de otros elementos. Por ejemplo, las pestañas no pueden anidarse dentro de groups. El editor web impide que anides elementos inválidos. @@ -131,14 +131,14 @@ Cada idioma mantiene la misma estructura de navegación con contenido traducido. **Agregar iconos:** -1. Haz clic con el botón derecho en un elemento de navegación. -2. Haz clic en **Configure**. +1. Sitúa el cursor sobre un elemento de navegación. +2. Haz clic en el icono de engranaje. 3. Haz clic en el campo icon. **Agregar etiquetas:** -1. Haz clic con el botón derecho en un elemento de navegación. -2. Haz clic en **Configure**. +1. Sitúa el cursor sobre un elemento de navegación. +2. Haz clic en el icono de engranaje. 3. Haz clic en el campo tag. 4. Escribe una etiqueta como "NEW" o "BETA" que resalte elementos importantes. diff --git a/es/editor/pages.mdx b/es/editor/pages.mdx index 609a74257..bc19898c8 100644 --- a/es/editor/pages.mdx +++ b/es/editor/pages.mdx @@ -43,7 +43,8 @@ Edita el contenido con vistas previas en tiempo real que muestran cómo se verá * **Agregar texto**: Escribe en el editor para ver cómo se ve el texto cuando se publica. * **Dar formato al texto**: Usa la barra de herramientas para poner texto en negrita, cursiva o aplicar otros formatos. * **Agregar componentes**: Presiona / para abrir el menú de componentes y seleccionar componentes. -* **Agregar imágenes**: Usa el componente de imagen desde el menú /. +* **Agregar imágenes**: Usa el componente de imagen desde el menú / o escribe /image. +* **Agregar videos**: Escribe /video para cargar o seleccionar un video. * **Insertar enlaces**: Selecciona texto y presiona Cmd + K. Consulta [Components](/es/components) para obtener la lista completa de componentes disponibles. @@ -66,8 +67,13 @@ Consulta [Formatear texto](/es/create/text) y [Formatear código](/es/create/cod Configura la configuración de las páginas para controlar cómo aparecen en la navigation, en los resultados de búsqueda y en el diseño de tu sitio. -1. Haz clic con el botón derecho en un archivo. -2. Haz clic en **Configure**. +Pasa el cursor sobre una página y haz clic en el icono de engranaje. También puedes hacer clic con el botón derecho en un archivo y seleccionar **Settings**. + + + Una página resaltada en la barra lateral de modo que el icono de engranaje de configuración sea visible. + + Una página resaltada en la barra lateral de modo que el icono de engranaje de configuración sea visible. +
### Personaliza la apariencia de la navegación @@ -127,4 +133,4 @@ Haz clic con el botón derecho en una página y selecciona **Delete**. Al elimin ### Ocultar páginas
-Para quitar una página de navigation sin eliminar el archivo, haz clic derecho sobre la página y selecciona **Hide Page**. La página se mueve a la sección **Unused pages** y no aparecerá en tu sitio publicado. El archivo permanece en tu repositorio y puedes volver a mostrar la página agregándola a la navigation de tu `docs.json`. \ No newline at end of file +Para quitar una página de navigation sin eliminar el archivo, habilita el interruptor **Hidden** en la configuración de la página. Una página oculta permanece en tu repositorio y los usuarios aún pueden acceder a ella yendo directamente a la URL de la página. Puedes volver a mostrar una página desde la configuración de la página o agregándola a la navigation de tu `docs.json`. \ No newline at end of file diff --git a/es/installation.mdx b/es/installation.mdx index 2916f63da..38b5b654c 100644 --- a/es/installation.mdx +++ b/es/installation.mdx @@ -1,7 +1,7 @@ --- title: "Instalar la CLI" description: "Usa la CLI para obtener una vista previa de la documentación de forma local, probar cambios en tiempo real y detectar problemas antes de implementar tu sitio de documentación." -keywords: ["CLI", "npm", "desarrollo local", "Node.js"] +keywords: ["CLI", "npm", "desarrollo local", "Node.js", "pnpm", "mint dev", "enlaces rotos", "accesibilidad"] --- Gráfico decorativo que representa la CLI. @@ -286,10 +286,10 @@ Si usas JetBrains, recomendamos el [plugin MDX para IntelliJ IDEA](https://plugi - Esto puede deberse a una versión desactualizada de Node. Prueba lo siguiente: + Esto puede deberse a una versión desactualizada de Node.js. Prueba lo siguiente: 1. Desinstala la versión actualmente instalada de la CLI de mint: `npm uninstall -g mint` - 2. Actualiza a Node.js. + 2. Actualiza a Node.js v20.17.0+. 3. Reinstala la CLI de mint: `npm install -g mint` diff --git a/es/integrations/analytics/overview.mdx b/es/integrations/analytics/overview.mdx index fa8435645..8766838bd 100644 --- a/es/integrations/analytics/overview.mdx +++ b/es/integrations/analytics/overview.mdx @@ -558,7 +558,7 @@ clip-rule="evenodd" Configura las credenciales de tu proveedor de Analytics en el objeto `integrations` de `docs.json`. Incluye solo las plataformas que deseas usar. - Las integraciones de Analytics solo requieren API keys públicas, que son accesibles para cualquier persona que visite tu sitio de documentación. Tus API keys privadas, que se combinan con las claves públicas en los sistemas de tus proveedores de Analytics, deben permanecer privadas. No incluyas API keys privadas en tu `docs.json`. + Las integraciones de Analytics solo requieren claves públicas de API, que son accesibles para cualquier persona que vea tu sitio de documentación. Tus claves privadas de API, que se emparejan con las claves públicas en el lado de los proveedores de Analytics, deben mantenerse privadas. No incluyas claves privadas de API en tu `docs.json`. ```json docs.json @@ -640,7 +640,6 @@ Configura las credenciales de tu proveedor de Analytics en el objeto `integratio } ``` -
## Eventos rastreados
@@ -716,5 +715,6 @@ Todos los eventos de seguimiento utilizan el prefijo `docs.`. | :-------------------------------------- | :-------------------------------------------------------------------------------------------------------- | | `docs.context_menu.copy_page` | Cuando un usuario copia la página actual como Markdown. | | `docs.context_menu.copy_mcp_link` | Cuando un usuario copia el enlace del servidor MCP alojado. | +| `docs.context_menu.copy_add_mcp_command` | Cuando un usuario copia el comando `npx add-mcp` para instalar el servidor MCP. | | `docs.context_menu.ai_provider_click` | Cuando un usuario hace clic en un proveedor de IA para crear una conversación con la página actual como contexto. | | `docs.context_menu.install_mcp_server` | Cuando un usuario instala el servidor MCP alojado en editores de código. | \ No newline at end of file diff --git a/es/integrations/privacy/osano.mdx b/es/integrations/privacy/osano.mdx index 217434172..00548ab73 100644 --- a/es/integrations/privacy/osano.mdx +++ b/es/integrations/privacy/osano.mdx @@ -1,43 +1,38 @@ --- title: "Osano" description: "Administra el consentimiento de cookies con la plataforma de privacidad Osano." -keywords: ["Integración de Osano", "gestor de consentimiento de cookies", "cumplimiento con el RGPD", "ID de configuración"] +keywords: ["Integración de Osano", "gestor de consentimiento de cookies", "cumplimiento con el RGPD"] --- -Agrega lo siguiente a tu archivo `docs.json` para habilitar el gestor de consentimiento de cookies de [Osano](https://www.osano.com/). +Añade el consentimiento de cookies de [Osano](https://www.osano.com/) a tu documentación con un [archivo JavaScript personalizado](/es/customize/custom-scripts#custom-javascript) en tu repositorio. + +
+ ## Configuración +
+ +Crea un archivo `osano.js` en tu repositorio de documentación con el siguiente contenido: - ```json Integration options in docs.json - "integrations": { - "osano": { - "scriptSource": "SOURCE" - } - } + ```js Format + var script = document.createElement("script"); + script.src = "OSANO_SCRIPT_URL"; + document.head.appendChild(script); ``` - ```json Example - "integrations": { - "osano": { - "scriptSource": "https://cmp.osano.com/2sUB2dqwqdkks/8dqwd-dwd86£-4a9b/osano.js" - } - } + ```js Ejemplo + var script = document.createElement("script"); + script.src = "https://cmp.osano.com/your-tenant-id/your-site-id/osano.js"; + document.head.appendChild(script); ``` -El valor de `scriptSource` se puede encontrar como el valor de `src` en el fragmento de código generado por Osano. Siempre comienza con `https://cmp.osano.com/` y termina con `/osano.js`. - -```html Code snippet from Osano -