mirror of
https://github.com/mintlify/docs.git
synced 2026-09-14 13:35:46 +08:00
Ethan Palm
9a4ec7b557
* Fix editor docs accuracy, split media page, clear translation orphans
Accuracy fixes, each verified against mintlify/mint or mintlify/server:
- pages.mdx: "Editors and managers can restore them" -> "admins".
"Manager" is not a Mintlify role.
- index.mdx: publishing on a feature branch does not automatically open a
pull request; you choose commit-to-branch or PR. Contradicted the
branching page's own table.
- branching-and-publishing.mdx: preview deployments build when you open a
pull request, not on every branch save. Confirmed in gitlabWebhooks
(handleMergeRequestOpenEvent) and cruxWebhooks (keyed on reviewId).
tutorial.mdx was already correct.
- settings.mdx: rewritten against editor-settings-form.tsx. The panel has
four sections, not "two layers", and the entire Appearance section was
undocumented - including "Open live preview in new tab", which
live-preview.mdx already linked readers to. Corrected three setting
labels, noted that draft PRs default to on, added the 20,000-character
instruction limit.
- live-preview.mdx: link now resolves to /editor/settings#appearance.
De-bloat:
- Split the media section out of pages.mdx (172 lines, 15 subtopics) into
editor/media.mdx and added it to the nav.
- Trimmed index.mdx from 11 sidebar-duplicating cards to 4.
Translation orphans and redirects:
- Deleted 7 translated files whose English source was removed in April and
June. The translate automation never cleaned them up, and in PR #6062 it
wrote into es|fr|zh/editor/media.mdx 34 days after the English source was
deleted.
- Dropped /editor/media -> /editor/pages so it stops shadowing the
recreated page.
- Added /{es,fr,zh}/editor/publish, completing an English-only redirect.
- Added /editor/collaborate and its language variants. That page was
deleted in June with no redirect and has been a live 404 since.
mint broken-links clean, mint a11y clean, vale 0/0/0 on changed files.
Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>
* Restructure editor docs: 14 pages to 9, cut UI description
The editor section had grown to 14 pages, about 40% of which described
things a user can see on screen. The ratio was 105 field-enumeration
bullets to 42 procedural steps.
New structure, organized around what is invisible rather than what is
on screen:
Overview absorbs git-essentials (concepts + the Git mapping table)
Tutorial unchanged
Edit content absorbs media and navigation
Publish branch mechanics, conflicts, git sync, commit signing
Review previews, pull requests, approve and merge
Collaborate comments + suggestions + real-time editing
Editor agent trimmed
Settings absorbs configurations as a pointer
Keyboard shortcuts unchanged
Removed: git-essentials, media, navigation, live-preview, comments,
suggestions, configurations, branching-and-publishing. Added: publish,
review, collaborate.
configurations.mdx was the clearest cut. It was a 193-line field-by-field
mirror of the Site configurations panel, which is a third rendering of
information already in the docs.json schema and in organize/settings-*
(2,694 lines). It is now a short section in settings.mdx covering only
what is specific to editing configuration from the editor: real-time
sync, the SVG logo constraint, and the redirects interface.
Also cut: block actions, the minimap, code block options, right-click
menu enumerations, page settings field lists (already delegated to
/organize/pages), and most screenshots of self-evident controls.
1,320 to 848 body lines. Field-enumeration bullets 105 to 29.
English redirects added for all eight removed pages. Language variants
deliberately omitted: es/fr/zh still carry the old structure, so
redirecting those paths now would shadow pages that still exist there.
The translation automation should mirror this restructure; verify
afterward that no orphans remain.
Vale vocabulary widened rather than reworded around: autocommit(s|ed|ing)?,
autosav(e|es|ed|ing), dotfile(s)?.
mint broken-links clean, mint a11y clean, vale 0 errors on editor/.
Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>
* Correct keyboard shortcuts against the editor keymap
Verified every documented shortcut against the bindings in mintlify/mint
rather than inferring them. The app-level set is exhaustive:
mod+backslash, mod+i, mod+k, mod+s, mod+shift+period, mod+z, shift+mod+d,
shift+mod+s. Visual-mode bindings come from the Tiptap extensions.
- Cmd/Ctrl+Shift+F ("Switch between Navigation and Files tree") does not
exist. No such binding is registered anywhere in the dashboard. Replaced
with the real binding at that spot in the UI: Cmd/Ctrl+Shift+. toggles
"Show all files".
- Added Heading 5 and Heading 6. Heading.configure sets levels 1-6 and
preserves the parent Mod-Alt-N shortcuts; the table stopped at 4.
- Added Cmd/Ctrl+G for accordion group, bound in Accordions.tsx.
Confirmed correct and unchanged: Cmd+K search, Cmd+I agent, Cmd+Shift+S
mode toggle, Cmd+Shift+D diff, Cmd+\ sidebar, Cmd+Shift+M comment,
Cmd+Shift+E suggesting mode, Cmd+Shift+X strikethrough, Cmd+K link,
Cmd+Enter line break, Cmd+Shift+8 unordered list, and that source mode
runs Monaco.
Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>
* Document auto publish, drop the deprecated deploy branch lock
Auto publish is available to all deployments, so the settings panel shows
"Auto publish" rather than "Main branch autocommits". It is not just a
rename: when it is on, the editor hides the branch selector and the
Publish button entirely (TopBar returns null for both), so there is no
pending state and no review step. Documented that behavior in
settings.mdx and added a note at the top of publish.mdx, since that page
otherwise assumes a publish step exists.
The deployment branch lock was deprecated and removed, so it stays out of
the docs. It was already dropped from settings.mdx in the restructure.
Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>
* 💅
* copy edit index
* Fix editor docs I verified against dead code
Three claims traced to code that never mounts. Ethan confirmed the diff
shortcut does not work, which exposed the pattern.
- Removed Cmd/Ctrl+Shift+D for diff view. It is registered only at
SubBar/index.tsx:488, inside EditorSubBar, which is exported and
imported by nothing. There is no live diff shortcut; exitDiff exists
only as an onClick in EditorModeContextMenu.
- Source mode runs CodeMirror, not Monaco. SourceEditor resolves through
source-editor/index.tsx to editor-view.tsx, which imports
@codemirror/state and @codemirror/view. Monaco is used only by
EmbedModal. The shortcut rows themselves were correct: CodeMirror's
defaultKeymap and searchKeymap match VS Code for toggle comment, move
line, duplicate line, find, and add cursor above/below, all confirmed
against @codemirror/commands.
- Rewrote the left panel section of pages.mdx. The tabs are Home and
Publishing (EditorNavigationSidebarContents.tsx:62), not Navigation and
Files. The Navigation/Files switcher lives in the same dead SubBar
component. Home renders the workspace file tree including private
pages; Publishing renders the site navigation and site settings.
Confirmed by the e2e helper openPublishingNavigation, which queries the
Publishing tab by role against the running app.
Also corrected in that section: the tree hides docs.json, dotfiles,
extensionless files, all-caps Markdown, and css/js/jsx/mjs/cjs/pdf unless
Show all files is on; "unlisted" was an invented term, replaced with a
link to /organize/hidden-pages; and the folder menu item is "New page",
confirmed by e2e, not "New file".
Added four source-mode bindings that are real and undocumented: Cmd+B and
Cmd+I insert Markdown markers, Cmd+Option+Shift+[ and ] fold and unfold
all.
Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>
* copy edit pages
* copy edit publish
* copy edit review
* copy edit settings
* copy edit collaborate
* Updated mintlify pages
- Updated quickstart.mdx
Mintlify-Source: dashboard-editor
* copy edit keyboard shortcuts
* Updated mintlify pages
- Updated quickstart.mdx
Mintlify-Source: dashboard-editor
* Revert "Updated mintlify pages"
This reverts commit 8d1b50cbfc.
* Updated mintlify pages
- Updated quickstart.mdx
Mintlify-Source: dashboard-editor
* fix editor edits
* Mirror the editor restructure into es, fr, and zh
Brings all three translated sites onto the same nine-page structure as
English instead of waiting for the translate automation, which has a
documented history of leaving orphans behind.
Content:
- Deleted 21 orphans: branching-and-publishing, comments, configurations,
git-essentials, live-preview, navigation, and suggestions in each
language. None had an English source after the restructure.
- Added publish, review, and collaborate in each language.
- Rewrote index, pages, settings, agent, and keyboard-shortcuts to match
the current English content, including Home/Publishing tabs, CodeMirror
source mode, Show all files, and the restored Appearance section.
- Kept the existing conventions: es uses usted, fr uses vous, keywords and
product UI labels stay in English, and every heading is wrapped in a
<div id="english-slug"> so cross-language anchors resolve. Verified that
every English anchor exists in all three languages.
Navigation and redirects:
- es.json, fr.json, and zh.json now list the same nine pages as docs.json.
- Removed six locale redirects that would have shadowed the new publish
and collaborate pages once they existed.
- Added 21 locale redirects for the removed pages and retargeted the
destinations that pointed at them.
- Retargeted four /editor/configurations redirects that pointed at
#site-configurations, an anchor dropped in the settings rewrite.
- Rewrote stale links in changelog, authentication-setup, concepts, and
glossary across all three languages, since broken-links does not follow
redirects.
English fixes needed first, all caused by the settings restructure:
- Restored ## Appearance. Two pages link to #appearance, and its four
preferences were otherwise undocumented.
- Restored ## Create draft pull requests by default, which changelog
links to and which defaults to on.
- Promoted Main branch autocommits from ### to ##; it was nested under PR
instructions, and its warning named a setting no longer on the page.
- Retargeted publish.mdx from the removed #auto-publish anchor.
- Fixed a missing space in the settings page intro.
mint broken-links clean, mint a11y clean (1042 files), vale 0 errors,
all five JSON files valid.
Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>
---------
Co-authored-by: Claude Opus 5 (1M context) <noreply@anthropic.com>
Co-authored-by: mintlify[bot] <109931778+mintlify[bot]@users.noreply.github.com>
110 lines
7.9 KiB
Plaintext
110 lines
7.9 KiB
Plaintext
---
|
|
title: "Conceptos"
|
|
description: "Entiende cómo Mintlify conecta tu organización, el repositorio de documentación, los flujos de edición, los despliegues y las funciones de IA."
|
|
keywords: ["conceptos", "cómo funciona Mintlify", "repositorio", "despliegue", "publicación", "IA"]
|
|
---
|
|
|
|
Mintlify convierte el contenido de un repositorio de Git en un sitio de documentación. Puedes trabajar desde el editor en tu navegador, tu entorno de desarrollo local o pedirle instrucciones al agente de Mintlify en Slack. Los tres flujos de trabajo actualizan el mismo repositorio. Mintlify convierte el contenido de tu repositorio en experiencias optimizadas para personas y agentes.
|
|
|
|
```mermaid
|
|
flowchart LR
|
|
Editors["Browser editors, local editors, and Mintlify agent"] --> Repo[("Documentation repository")]
|
|
Repo --> Build["Build and deployment"]
|
|
Build --> Site["Live documentation site"]
|
|
Site --> Readers["People"]
|
|
Site --> AI["AI agents"]
|
|
```
|
|
|
|
<div id="organizations-deployments-and-sites">
|
|
## Organizaciones, despliegues y sitios
|
|
</div>
|
|
|
|
Una **organización** es el espacio de trabajo para tu equipo. Contiene a tus miembros, la configuración a nivel de organización y uno o más despliegues.
|
|
|
|
Un **despliegue** es un proyecto de documentación en tu organización. Conecta un repositorio, un directorio de contenido y una rama de despliegue con un sitio publicado. Una organización puede tener varios despliegues para productos o propiedades de documentación distintos.
|
|
|
|
Un **sitio en vivo** es el resultado publicado de un despliegue. Mintlify proporciona una URL `.mintlify.site` de forma predeterminada. Puedes conectar un [dominio personalizado](/es/customize/custom-domain) para tu sitio. Los sitios incluyen tu contenido, navegación, búsqueda y cualquier función que habilites, como el asistente o el playground de la API.
|
|
|
|
<Note>
|
|
La documentación a veces utiliza **proyecto** como un nombre general para un despliegue y su repositorio, configuración y sitio conectados.
|
|
</Note>
|
|
|
|
<div id="the-repository-is-the-source-of-truth">
|
|
## El repositorio es la fuente de verdad
|
|
</div>
|
|
|
|
El repositorio de tu documentación contiene los archivos que definen tu sitio. Mintlify lee estos archivos durante cada build.
|
|
|
|
- Las **páginas** son archivos `.mdx`. Cada página contiene contenido y metadatos en el frontmatter.
|
|
- `docs.json` es el archivo de configuración obligatorio. Controla la navegación, la apariencia, las integraciones, la configuración de la API y otros comportamientos globales del sitio.
|
|
- Los **recursos** incluyen imágenes, vídeos, fuentes y archivos descargables a los que hacen referencia tus páginas.
|
|
- Las **especificaciones de API** pueden generar páginas de referencia de API y playgrounds interactivos a partir de esquemas OpenAPI, AsyncAPI o GraphQL.
|
|
- Los **archivos reutilizables** incluyen fragmentos y componentes personalizados de React que las páginas pueden importar.
|
|
|
|
Tu repositorio puede contener archivos no publicados. Una página aparece en la navegación del sitio solo cuando la referencias en la navegación de tu [`docs.json`](/es/organize/navigation); de lo contrario, permanece oculta. Las [páginas ocultas](/es/organize/hidden-pages) solo son accesibles mediante un enlace directo.
|
|
|
|
<div id="pages-and-navigation-are-separate">
|
|
## Las páginas y la navegación son independientes
|
|
</div>
|
|
|
|
Una **página** proporciona el contenido en una URL. Su [frontmatter](/es/organize/pages) controla los metadatos y el comportamiento a nivel de página, incluidos su título, descripción, icono y diseño.
|
|
|
|
La **navegación** determina cómo los lectores se desplazan por las páginas. Configura la navegación en tu archivo `docs.json` usando elementos como grupos, pestañas, menús desplegables, productos, versiones e idiomas. La ruta del archivo identifica una página y su posición en `docs.json` determina dónde aparece en la navegación.
|
|
|
|
Esta separación te permite reorganizar la experiencia del lector sin mover archivos. También te permite excluir páginas de utilidad de la navegación mientras las mantienes disponibles por URL.
|
|
|
|
<div id="editing-and-publishing-are-different-stages">
|
|
## Editar y publicar son etapas diferentes
|
|
</div>
|
|
|
|
Puedes editar el mismo contenido mediante dos flujos de trabajo principales.
|
|
|
|
| Flujo de trabajo | Dónde editas | Cómo llegan los cambios a Git | Cómo previsualizas |
|
|
| --- | --- | --- | --- |
|
|
| Editor | Panel de Mintlify en tu navegador | El editor crea commits y puede abrir solicitudes de extracción | Vista previa en vivo en el editor |
|
|
| Desarrollo local | Tu editor preferido | Haces commit y push con Git | Comando de CLI `mint dev` |
|
|
|
|
En el editor, los cambios se **guardan** automáticamente, pero no actualizan de inmediato tu repositorio ni tu sitio en vivo. Cuando **publicas**, el editor escribe los cambios en Git. Lo que ocurre a continuación depende de tu rama actual y de la configuración de protección de rama.
|
|
|
|
- En la **rama de despliegue**, publicar puede activar directamente un build del sitio en vivo.
|
|
- En una **rama de funcionalidad**, publicar puede guardar los cambios en la rama o crear una solicitud de extracción para su revisión.
|
|
- Un **despliegue de vista previa** renderiza una solicitud de extracción en una URL temporal para que los revisores puedan inspeccionar el resultado antes de fusionarla.
|
|
- Fusionar una solicitud de extracción en la rama de despliegue activa un despliegue de producción.
|
|
|
|
Consulta [Ramas y publicación](/es/editor/publish) para conocer el flujo de trabajo completo.
|
|
|
|
<div id="a-build-turns-source-files-into-reader-experiences">
|
|
## Un build convierte los archivos fuente en experiencias para el lector
|
|
</div>
|
|
|
|
Cuando el contenido llega a la rama de despliegue, Mintlify valida el proyecto, renderiza las páginas y despliega el sitio. El mismo contenido fuente admite varias formas de encontrar y consumir información:
|
|
|
|
- El sitio de documentación renderiza páginas para personas en escritorio y móvil.
|
|
- La búsqueda indexa el sitio para que los lectores puedan encontrar las páginas relevantes.
|
|
- El asistente responde preguntas a partir de la documentación y cita sus fuentes.
|
|
- Las versiones en Markdown de las páginas, `llms.txt` y `skill.md` ayudan a las herramientas de IA a entender el contenido.
|
|
- Un servidor MCP público permite que las herramientas de IA compatibles recuperen la documentación como contexto estructurado.
|
|
|
|
Ejecuta [`mint validate`](/es/cli/commands#mint-validate) y [`mint broken-links`](/es/cli/commands#mint-broken-links) antes de publicar para detectar problemas comunes de forma local.
|
|
|
|
<div id="mintlifys-ai-features-have-different-roles">
|
|
## Las funciones de IA de Mintlify tienen roles distintos
|
|
</div>
|
|
|
|
Mintlify ofrece funciones de IA independientes para leer, escribir, automatizar y acceder a herramientas externas.
|
|
|
|
| Función | Utilizado por | Propósito | Modifica el contenido |
|
|
| --- | --- | --- | --- |
|
|
| [Assistant](/es/assistant) | Lectores de la documentación | Responde preguntas a partir de tu contenido | No |
|
|
| [Agent](/es/agent) | Mantenedores de la documentación | Investiga y propone actualizaciones de contenido o configuración | Sí |
|
|
| [Automatizaciones](/es/automations/index) | Mantenedores de la documentación | Ejecuta el agente desde una programación, una actualización del repositorio o un evento de integración | Sí |
|
|
| [Servidor MCP de búsqueda](/es/ai/model-context-protocol) | Agentes | Recupera contexto de un sitio de documentación publicado | No |
|
|
| [Servidor MCP de administración](/es/ai/mintlify-mcp) | Agentes | Lee y actualiza despliegues mediante herramientas autenticadas | Sí |
|
|
| [Mintlify Index](/es/search-index) | Agentes | Recupera contexto técnico actualizado de todos los sitios públicos de Mintlify y de la web | No |
|
|
|
|
<div id="learn-the-terminology">
|
|
## Aprende la terminología
|
|
</div>
|
|
|
|
Consulta el [glosario](/es/reference/glossary) para conocer las definiciones de los términos de Mintlify, Git, publicación, navegación, API e IA que se utilizan a lo largo de la documentación.
|