diff --git a/.claude/commands/review.md b/.claude/commands/review.md index f75a18c3d..094dd4ece 100644 --- a/.claude/commands/review.md +++ b/.claude/commands/review.md @@ -9,6 +9,7 @@ Please review the changes I'm about to commit and check: 3. Are any code examples accurate? 4. Is the frontmatter complete and correct? 5. Does the content match our existing style? -6. Are there any links that need testing? +6. Run vale on the files being updated and make a plan to resolve any errors, warnings, and suggestions. +7. Are there any links that need testing? $ARGUMENTS diff --git a/.vale.ini b/.vale.ini new file mode 100644 index 000000000..febeefd3b --- /dev/null +++ b/.vale.ini @@ -0,0 +1,31 @@ +# Vale configuration for Mintlify documentation + +StylesPath = .vale/styles +MinAlertLevel = suggestion +IgnoredScopes = code, tt, img, url, a +SkippedScopes = script, style, pre, figure, code + +Packages = Google + +Vocab = Mintlify + +# This is required since Vale doesn't officially support MDX +[formats] +mdx = md + +# MDX support +[*.mdx] +BasedOnStyles = Vale, Google +Vale.Terms = NO # Enforces really harsh capitalization rules, keep off +Vale.Avoid = NO # Too aggressive about common technical terms + +# Token and block ignores for MDX-specific syntax +TokenIgnores = (?sm)((?:import|export) .+?$), \ +(?)(?!`), \ +(<[A-Z]\w+>.+?<\/[A-Z]\w+>), \ +(<[^>]*>) + +BlockIgnores = (?sm)^(<\w+\n .*\s\/>)$, \ +(?sm)^({.+.*}) + +CommentDelimiters = {/*, */} \ No newline at end of file diff --git a/.vale/README.md b/.vale/README.md new file mode 100644 index 000000000..98d533d45 --- /dev/null +++ b/.vale/README.md @@ -0,0 +1,45 @@ +# Vale Configuration for Mintlify Docs + +This directory contains the Vale linting configuration for Mintlify documentation. + +## Philosophy + +Start simple and grow incrementally as needs emerge. The current setup uses: + +- Core Mintlify-specific vocabulary +- Customized rules from the Google developer documentation style guide + +## Vale files +- `.vale.ini` - Main configuration file +- `styles/config/vocabularies/Mintlify/` - Mintlify-specific terms +- `styles/Google/` - Google developer documentation style rules customized for Mintlify docs + +## When to add vocabulary +- **Mintlify terms** - New components, features, platform-specific concepts +- **Frequent false positives** - Any terms that repeatedly trigger spelling errors, but shouldn't + +### Discover new vocabulary +Use the included script to find vocabulary candidates: +```bash +# Discover terms from all files +.vale/scripts/discover-vocabulary.sh + +# Discover from specific files +.vale/scripts/discover-vocabulary.sh "components/*.mdx" +``` + +This script: +1. Runs Vale on specified files +2. Extracts spelling error suggestions +3. Saves results to `.vale/vocabulary-candidates.txt` + +## When to add new rules +- **Consistent patterns** - The same style issue appears frequently +- **High-value, low-noise** - Rules that catch problems with minimal false positives + +### Testing new rules +Before adding a new rule: +1. Test locally: `vale path/to/file.mdx` +2. Run on sample files: `vale components/*.mdx` +3. Check false positive rate +4. Start with `level: suggestion` then promote to `warning` or `error` diff --git a/.vale/scripts/discover-vocabulary.sh b/.vale/scripts/discover-vocabulary.sh new file mode 100755 index 000000000..2c57423e4 --- /dev/null +++ b/.vale/scripts/discover-vocabulary.sh @@ -0,0 +1,33 @@ +#!/bin/bash +# Script to discover potential vocabulary terms from Vale output +# Usage: ./discover-vocabulary.sh [file-pattern] + +set -e + +PATTERN=${1:-"**/*.mdx"} +OUTPUT_FILE=".vale/vocabulary-candidates.txt" + +echo "🔍 Discovering vocabulary candidates from Vale spelling errors..." +echo "Pattern: $PATTERN" +echo "" + +# Run Vale and extract spelling error words +vale --no-exit $PATTERN 2>&1 | \ +grep "Vale.Spelling" | \ +sed -n "s/.*Did you really mean '\([^']*\)'.*/\1/p" | \ +sort | uniq -c | sort -nr > "$OUTPUT_FILE" + +if [ -s "$OUTPUT_FILE" ]; then + echo "Found vocabulary candidates in $OUTPUT_FILE:" + echo "" + head -20 "$OUTPUT_FILE" + echo "" + echo "Review these terms and add appropriate ones to:" + echo " - .vale/styles/config/vocabularies/Mintlify/accept.txt (if valid)" + echo " - .vale/styles/config/vocabularies/Mintlify/reject.txt (if misspellings)" + echo "" + echo "To clean up this file: rm $OUTPUT_FILE" +else + echo "✅ No vocabulary issues found!" + rm -f "$OUTPUT_FILE" +fi \ No newline at end of file diff --git a/.vale/styles/Google/AMPM.yml b/.vale/styles/Google/AMPM.yml new file mode 100644 index 000000000..37b49edf8 --- /dev/null +++ b/.vale/styles/Google/AMPM.yml @@ -0,0 +1,9 @@ +extends: existence +message: "Use 'AM' or 'PM' (preceded by a space)." +link: "https://developers.google.com/style/word-list" +level: error +nonword: true +tokens: + - '\d{1,2}[AP]M\b' + - '\d{1,2} ?[ap]m\b' + - '\d{1,2} ?[aApP]\.[mM]\.' diff --git a/.vale/styles/Google/Acronyms.yml b/.vale/styles/Google/Acronyms.yml new file mode 100644 index 000000000..f41af0189 --- /dev/null +++ b/.vale/styles/Google/Acronyms.yml @@ -0,0 +1,64 @@ +extends: conditional +message: "Spell out '%s', if it's unfamiliar to the audience." +link: 'https://developers.google.com/style/abbreviations' +level: suggestion +ignorecase: false +# Ensures that the existence of 'first' implies the existence of 'second'. +first: '\b([A-Z]{3,5})\b' +second: '(?:\b[A-Z][a-z]+ )+\(([A-Z]{3,5})\)' +# ... with the exception of these: +exceptions: + - API + - ASP + - CLI + - CPU + - CSS + - CSV + - DEBUG + - DOM + - DPI + - FAQ + - GCC + - GDB + - GET + - GPU + - GTK + - GUI + - HTML + - HTTP + - HTTPS + - IDE + - JAR + - JSON + - JSX + - LESS + - LLDB + - NET + - NOTE + - NVDA + - OSS + - PATH + - PDF + - PHP + - POST + - RAM + - REPL + - RSA + - SCM + - SCSS + - SDK + - SQL + - SSH + - SSL + - SVG + - TBD + - TCP + - TODO + - URI + - URL + - USB + - UTF + - XML + - XSS + - YAML + - ZIP diff --git a/.vale/styles/Google/DateFormat.yml b/.vale/styles/Google/DateFormat.yml new file mode 100644 index 000000000..e9d227fa1 --- /dev/null +++ b/.vale/styles/Google/DateFormat.yml @@ -0,0 +1,9 @@ +extends: existence +message: "Use 'July 31, 2016' format, not '%s'." +link: 'https://developers.google.com/style/dates-times' +ignorecase: true +level: error +nonword: true +tokens: + - '\d{1,2}(?:\.|/)\d{1,2}(?:\.|/)\d{4}' + - '\d{1,2} (?:Jan(?:uary)?|Feb(?:ruary)?|Mar(?:ch)?|Apr(?:il)|May|Jun(?:e)|Jul(?:y)|Aug(?:ust)|Sep(?:tember)?|Oct(?:ober)|Nov(?:ember)?|Dec(?:ember)?) \d{4}' diff --git a/.vale/styles/Google/Ellipses.yml b/.vale/styles/Google/Ellipses.yml new file mode 100644 index 000000000..1e070517b --- /dev/null +++ b/.vale/styles/Google/Ellipses.yml @@ -0,0 +1,9 @@ +extends: existence +message: "In general, don't use an ellipsis." +link: 'https://developers.google.com/style/ellipses' +nonword: true +level: warning +action: + name: remove +tokens: + - '\.\.\.' diff --git a/.vale/styles/Google/EmDash.yml b/.vale/styles/Google/EmDash.yml new file mode 100644 index 000000000..6068c2c75 --- /dev/null +++ b/.vale/styles/Google/EmDash.yml @@ -0,0 +1,13 @@ +extends: existence +message: "Don't put a space before or after an em dash." +link: "https://developers.google.com/style/dashes" +nonword: true +level: error +action: + name: edit + params: + - trim + - " " +tokens: + - '\s[—–]\s' + diff --git a/.vale/styles/Google/Exclamation.yml b/.vale/styles/Google/Exclamation.yml new file mode 100644 index 000000000..4d9bb874e --- /dev/null +++ b/.vale/styles/Google/Exclamation.yml @@ -0,0 +1,12 @@ +extends: existence +message: "Don't use exclamation points in text." +link: "https://developers.google.com/style/exclamation-points" +nonword: true +level: warning +action: + name: edit + params: + - trim_right + - "!" +tokens: + - '\w+!(?:\s|$)' diff --git a/.vale/styles/Google/HeadingPunctuation.yml b/.vale/styles/Google/HeadingPunctuation.yml new file mode 100644 index 000000000..c1729868b --- /dev/null +++ b/.vale/styles/Google/HeadingPunctuation.yml @@ -0,0 +1,13 @@ +extends: existence +message: "Don't put a period at the end of a heading." +link: "https://developers.google.com/style/capitalization#capitalization-in-titles-and-headings" +nonword: true +level: warning +scope: heading +action: + name: edit + params: + - trim_right + - "." +tokens: + - '[a-z0-9][.]\s*$' diff --git a/.vale/styles/Google/Headings.yml b/.vale/styles/Google/Headings.yml new file mode 100644 index 000000000..6e2645923 --- /dev/null +++ b/.vale/styles/Google/Headings.yml @@ -0,0 +1,42 @@ +extends: capitalization +message: "'%s' should use sentence-style capitalization." +link: "https://developers.google.com/style/capitalization#capitalization-in-titles-and-headings" +level: warning +scope: heading +match: $sentence +exceptions: + - API + - APIs + - CDN + - CORS + - CLI + - Cloudflare + - Cloudflare Worker + - CSS + - DNS + - GitHub + - GitHub App + - GitLab + - HTML + - JavaScript + - JSON + - JWT + - Linux + - macOS + - Mintlify + - MDX + - OAuth + - OpenAPI + - PDF + - SAML + - SDK + - SSL + - SSO + - TLS + - TypeScript + - UI + - UX + - URL + - URLs + - Vercel + - Windows diff --git a/.vale/styles/Google/Latin.yml b/.vale/styles/Google/Latin.yml new file mode 100644 index 000000000..ca03b9154 --- /dev/null +++ b/.vale/styles/Google/Latin.yml @@ -0,0 +1,11 @@ +extends: substitution +message: "Use '%s' instead of '%s'." +link: 'https://developers.google.com/style/abbreviations' +ignorecase: true +level: error +nonword: true +action: + name: replace +swap: + '\b(?:eg|e\.g\.)(?=[\s,;])': for example + '\b(?:ie|i\.e\.)(?=[\s,;])': that is diff --git a/.vale/styles/Google/LyHyphens.yml b/.vale/styles/Google/LyHyphens.yml new file mode 100644 index 000000000..50dacb40d --- /dev/null +++ b/.vale/styles/Google/LyHyphens.yml @@ -0,0 +1,14 @@ +extends: existence +message: "'%s' doesn't need a hyphen." +link: "https://developers.google.com/style/hyphens" +level: error +ignorecase: false +nonword: true +action: + name: edit + params: + - regex + - "-" + - " " +tokens: + - '\b[^\s-]+ly-\w+\b' diff --git a/.vale/styles/Google/OptionalPlurals.yml b/.vale/styles/Google/OptionalPlurals.yml new file mode 100644 index 000000000..4a8767d6f --- /dev/null +++ b/.vale/styles/Google/OptionalPlurals.yml @@ -0,0 +1,12 @@ +extends: existence +message: "Don't use plurals in parentheses such as in '%s'." +link: "https://developers.google.com/style/plurals-parentheses" +level: error +nonword: true +action: + name: edit + params: + - trim_right + - "(s)" +tokens: + - '\b\w+\(s\)' diff --git a/.vale/styles/Google/Ordinal.yml b/.vale/styles/Google/Ordinal.yml new file mode 100644 index 000000000..d1ac7d27e --- /dev/null +++ b/.vale/styles/Google/Ordinal.yml @@ -0,0 +1,7 @@ +extends: existence +message: "Spell out all ordinal numbers ('%s') in text." +link: 'https://developers.google.com/style/numbers' +level: error +nonword: true +tokens: + - \d+(?:st|nd|rd|th) diff --git a/.vale/styles/Google/OxfordComma.yml b/.vale/styles/Google/OxfordComma.yml new file mode 100644 index 000000000..b9ba21ebb --- /dev/null +++ b/.vale/styles/Google/OxfordComma.yml @@ -0,0 +1,7 @@ +extends: existence +message: "Use the Oxford comma in '%s'." +link: 'https://developers.google.com/style/commas' +scope: sentence +level: warning +tokens: + - '(?:[^,]+,){1,}\s\w+\s(?:and|or)' diff --git a/.vale/styles/Google/Parens.yml b/.vale/styles/Google/Parens.yml new file mode 100644 index 000000000..3b8711d0c --- /dev/null +++ b/.vale/styles/Google/Parens.yml @@ -0,0 +1,7 @@ +extends: existence +message: "Use parentheses judiciously." +link: 'https://developers.google.com/style/parentheses' +nonword: true +level: suggestion +tokens: + - '\(.+\)' diff --git a/.vale/styles/Google/Passive.yml b/.vale/styles/Google/Passive.yml new file mode 100644 index 000000000..3265890e5 --- /dev/null +++ b/.vale/styles/Google/Passive.yml @@ -0,0 +1,184 @@ +extends: existence +link: 'https://developers.google.com/style/voice' +message: "In general, use active voice instead of passive voice ('%s')." +ignorecase: true +level: suggestion +raw: + - \b(am|are|were|being|is|been|was|be)\b\s* +tokens: + - '[\w]+ed' + - awoken + - beat + - become + - been + - begun + - bent + - beset + - bet + - bid + - bidden + - bitten + - bled + - blown + - born + - bought + - bound + - bred + - broadcast + - broken + - brought + - built + - burnt + - burst + - cast + - caught + - chosen + - clung + - come + - cost + - crept + - cut + - dealt + - dived + - done + - drawn + - dreamt + - driven + - drunk + - dug + - eaten + - fallen + - fed + - felt + - fit + - fled + - flown + - flung + - forbidden + - foregone + - forgiven + - forgotten + - forsaken + - fought + - found + - frozen + - given + - gone + - gotten + - ground + - grown + - heard + - held + - hidden + - hit + - hung + - hurt + - kept + - knelt + - knit + - known + - laid + - lain + - leapt + - learnt + - led + - left + - lent + - let + - lighted + - lost + - made + - meant + - met + - misspelt + - mistaken + - mown + - overcome + - overdone + - overtaken + - overthrown + - paid + - pled + - proven + - put + - quit + - read + - rid + - ridden + - risen + - run + - rung + - said + - sat + - sawn + - seen + - sent + - set + - sewn + - shaken + - shaven + - shed + - shod + - shone + - shorn + - shot + - shown + - shrunk + - shut + - slain + - slept + - slid + - slit + - slung + - smitten + - sold + - sought + - sown + - sped + - spent + - spilt + - spit + - split + - spoken + - spread + - sprung + - spun + - stolen + - stood + - stridden + - striven + - struck + - strung + - stuck + - stung + - stunk + - sung + - sunk + - swept + - swollen + - sworn + - swum + - swung + - taken + - taught + - thought + - thrived + - thrown + - thrust + - told + - torn + - trodden + - understood + - upheld + - upset + - wed + - wept + - withheld + - withstood + - woken + - won + - worn + - wound + - woven + - written + - wrung diff --git a/.vale/styles/Google/Periods.yml b/.vale/styles/Google/Periods.yml new file mode 100644 index 000000000..d24a6a6c0 --- /dev/null +++ b/.vale/styles/Google/Periods.yml @@ -0,0 +1,7 @@ +extends: existence +message: "Don't use periods with acronyms or initialisms such as '%s'." +link: 'https://developers.google.com/style/abbreviations' +level: error +nonword: true +tokens: + - '\b(?:[A-Z]\.){3,}' diff --git a/.vale/styles/Google/Quotes.yml b/.vale/styles/Google/Quotes.yml new file mode 100644 index 000000000..d8eb51fd3 --- /dev/null +++ b/.vale/styles/Google/Quotes.yml @@ -0,0 +1,8 @@ +extends: existence +message: "Commas and periods go inside quotation marks." +link: 'https://developers.google.com/style/quotation-marks' +level: error +nonword: true +tokens: + # Match quotes with trailing punctuation, but exclude content in JSON + - '(? 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 (e.g. `.okta.com`). You can send these via a service like 1Password or SendSafely. + 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. @@ -97,7 +97,7 @@ Use single sign-on to your dashboard via SAML and OIDC. If you use Okta, Google - 1. Under "Enterprise applications", select **New application**. + 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)." diff --git a/advanced/subpath/route53-cloudfront.mdx b/advanced/subpath/route53-cloudfront.mdx index a39be3c41..bcd6589e0 100644 --- a/advanced/subpath/route53-cloudfront.mdx +++ b/advanced/subpath/route53-cloudfront.mdx @@ -70,7 +70,7 @@ All Behaviors must have the an **origin request policy** of `AllViewerExceptHost If you use Vercel, use the `.vercel.app` domain available for every project. -3. Create a new Origin and add your staging URL as the "Origin domain". +3. Create a new Origin and add your staging URL as the "Origin domain." ![CloudFront "Create origin" page with a "Origin domain" input field highlighted.](/images/cloudfront/default-origin.png) @@ -101,7 +101,7 @@ Behaviors in CloudFront enable control over the subpath logic. At a high level, Create behaviors for Vercel domain verification paths with a **Path pattern** of `/.well-known/*` and set **Origin and origin groups** to your docs URL. -For "Cache policy", select **CachingDisabled** to ensure these verification requests pass through without caching. +For "Cache policy," select **CachingDisabled** to ensure these verification requests pass through without caching. ![CloudFront "Create behavior" page with a "Path pattern" of "/.well-known/*" and "Origin and origin groups" pointing to the staging URL.](/images/cloudfront/well-known-policy.png) diff --git a/ai/slack-app.mdx b/ai/slack-app.mdx index ca2705b90..3335a5834 100644 --- a/ai/slack-app.mdx +++ b/ai/slack-app.mdx @@ -5,7 +5,7 @@ icon: "slack" --- - The Slack app is available for [Pro and Enterprise plans](https://mintlify.com/pricing?ref=slack-app). + The Slack app is available for [Pro and Custom plans](https://mintlify.com/pricing?ref=slack-app). The Slack app adds a bot named `@mintlify` to your Slack workspace that can search your documentation and answer users' questions. The bot responds to direct messages, @mentions, and to any questions in a channel specifically named `#ask-ai`. diff --git a/api-playground/overview.mdx b/api-playground/overview.mdx index cbabdc303..aa0ada383 100644 --- a/api-playground/overview.mdx +++ b/api-playground/overview.mdx @@ -25,7 +25,7 @@ We recommend generating your API playground from an OpenAPI specification. See [ Make sure that your OpenAPI specification file is valid using the [Swagger Editor](https://editor.swagger.io/) or [Mint CLI](https://www.npmjs.com/package/mint). - ```bash {2} + ```bash {3} /your-project |- docs.json |- openapi.json diff --git a/changelog.mdx b/changelog.mdx index 8a0e11113..92d56b10e 100644 --- a/changelog.mdx +++ b/changelog.mdx @@ -5,6 +5,29 @@ rss: true noindex: true --- + + +## GitLab integration enhancements + +- Enhanced GitLab connection UI in dashboard settings for easier repository management +- Added webhook support for automatic documentation updates on GitLab commits + +## Web editor and authentication improvements + +- Continued app router migration for the web editor, removing blockers and improving performance +- Enhanced login error handling with explicit email validation messages +- Fixed whitespace handling in email address validation + +## Bug fixes and reliability + +- Fixed app router socket update functionality for real-time features +- Fixed SVG path rendering issues in documentation +- Fixed keyboard navigation in search and chat functionality +- Fixed history status endpoint reliability +- Resolved middleware edge cases and onClick event handling issues + + + ## Major releases @@ -184,7 +207,7 @@ noindex: true ## API playground enhancements - New [Search API endpoint](https://mintlify.com/docs/api-reference/assistant/search) so you can build agents and MCP servers on top of your docs - - `openapi` and `asyncapi` files are now served at their specified paths (e.g. `https://mydocsurl.extension/{openapi-or-file-name}.json`) + - `openapi` and `asyncapi` files are now served at their specified paths (for example, `https://mydocsurl.extension/{openapi-or-file-name}.json`) - You can now use the [`x-mint` field in your openapi files](https://mintlify.com/docs/api-playground/openapi-setup#x-mint-extension) to override generated fields, customize preface content, or change endpoint URLs in code samples - [`x-mcp` is now `x-mint.mcp`](https://mintlify.com/docs/api-playground/openapi-setup#mcp) in OpenAPI configurations to control which routes are exposed as MCP tools @@ -426,7 +449,7 @@ noindex: true ## AI Assistant Improvements - New UI with dedicated chat page & pre-filled prompts - - Stability improvements, e.g. bug fixes of editing the wrong file or no files at all + - Stability improvements. For example, bug fixes of editing the wrong file or no files at all - More robust knowledge for adding & editing components - Improved `docs.json` file editing @@ -439,7 +462,7 @@ noindex: true We’ve overhauled the design and performance of the [API Playground](/api-playground/). Updates include: - Easier detail expansion for an overview of a field - - More intuitive nested design, e.g. adding or deleting items + - More intuitive nested design. For example, adding or deleting items - Faster response times ## Quality Improvements diff --git a/code.mdx b/code.mdx index 9cdebff96..2ea701e37 100644 --- a/code.mdx +++ b/code.mdx @@ -59,6 +59,8 @@ Enable syntax highlighting by specifying the programming language after the open We use [Shiki](https://shiki.style/) for syntax highlighting and support all available languages. See the full list of [languages](https://shiki.style/languages) in Shiki's documentation. +Customize code block themes globally using `styling.codeblocks` in your `docs.json` file. Set simple themes like `system` or `dark`, or configure custom [Shiki themes](https://shiki.style/themes) for light and dark modes. See [Settings](/settings#styling) for detailed configuration options. + ```java class HelloWorld { public static void main(String[] args) { diff --git a/components/cards.mdx b/components/cards.mdx index 87323c823..db1151f79 100644 --- a/components/cards.mdx +++ b/components/cards.mdx @@ -107,7 +107,7 @@ Use the [Columns component](/components/columns) to organize multiple cards side - Icon color as a hex code (e.g., `#FF6B6B`). + Icon color as a hex code (for example, `#FF6B6B`). diff --git a/components/code-groups.mdx b/components/code-groups.mdx index a4694711e..f8574ecbc 100644 --- a/components/code-groups.mdx +++ b/components/code-groups.mdx @@ -26,6 +26,8 @@ class HelloWorld { +Code groups inherit global styling from your `docs.json` file. Customize your theme using `styling.codeblocks`. See [Settings](/settings#styling) for configuration options. + ## Creating code groups To create a code group, wrap multiple code blocks with `` tags. Each code block must include a title, which becomes the tab label. diff --git a/docs.json b/docs.json index 93962f72f..54cb68139 100644 --- a/docs.json +++ b/docs.json @@ -286,7 +286,7 @@ "tab": "Documentation", "groups": [ { - "group": "Premiers pas", + "group": "Démarrage", "pages": [ "fr/index", "fr/quickstart", @@ -479,7 +479,7 @@ ] }, { - "group": "Assistance", + "group": "Support", "icon": "messages-square", "pages": [ "fr/integrations/support/overview", @@ -574,7 +574,7 @@ ] }, { - "group": "Configuración central", + "group": "Configuración principal", "pages": [ "es/settings", "es/pages", @@ -776,16 +776,16 @@ ] }, { - "tab": "Referencia de la API", + "tab": "Referencia de API", "groups": [ { - "group": "Referencia de API", + "group": "Referencia de la API", "pages": [ "es/api-reference/introduction" ] }, { - "group": "Administrador", + "group": "Administración", "pages": [ "es/api-reference/update/trigger", "es/api-reference/update/status" @@ -851,7 +851,7 @@ ] }, { - "group": "AI优化", + "group": "AI 优化", "pages": [ "zh/guides/assistant", "zh/ai/llmstxt", @@ -909,7 +909,7 @@ ] }, { - "group": "AsyncAPI规范", + "group": "AsyncAPI", "icon": "webhook", "pages": [ "zh/api-playground/asyncapi/setup", @@ -967,7 +967,7 @@ ] }, { - "group": "仪表盘访问权限", + "group": "仪表盘访问", "icon": "gauge", "pages": [ "zh/advanced/dashboard/sso", @@ -1068,7 +1068,7 @@ ] }, { - "tab": "更新日志", + "tab": "变更日志", "groups": [ { "group": "变更日志", diff --git a/es/advanced/dashboard/permissions.mdx b/es/advanced/dashboard/permissions.mdx index 2934b173f..5f1112994 100644 --- a/es/advanced/dashboard/permissions.mdx +++ b/es/advanced/dashboard/permissions.mdx @@ -1,14 +1,14 @@ --- -title: "Permisos de editor" -description: "Permite que más miembros de tu equipo actualicen tu documentación" +title: 'Permisos del editor' +description: 'Permite que más miembros de tu equipo actualicen tu documentación' --- -Un editor tiene acceso a tu panel y al editor web. +Un editor tiene acceso a tu panel de control y al editor web. -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: +Cualquiera puede contribuir a tu documentación trabajando localmente y enviando cambios a tu repositorio, pero hay diferencias clave en cómo se despliegan los cambios: -* **Cambios de editor**: Cuando un editor publica a través del editor web o fusiona una pull request en tu repositorio de documentación, los cambios se despliegan automáticamente en tu sitio en vivo. -* **Cambios de no editor**: Cuando alguien que no es editor fusiona una pull request en tu repositorio, debes activar manualmente un despliegue desde tu panel para que esos cambios aparezcan en tu sitio en vivo. +* **Cambios de editor**: Cuando un editor publica a través del editor web o fusiona una pull request en el repositorio de tu documentación, los cambios se despliegan automáticamente en tu sitio en producción. +* **Cambios de no editor**: Cuando una persona que no es editora fusiona una pull request en tu repositorio, debes activar manualmente un despliegue desde tu panel de control para que esos cambios aparezcan en tu sitio en producción. diff --git a/es/advanced/dashboard/roles.mdx b/es/advanced/dashboard/roles.mdx index 3443e2ac6..eba3b9b15 100644 --- a/es/advanced/dashboard/roles.mdx +++ b/es/advanced/dashboard/roles.mdx @@ -7,20 +7,20 @@ description: "Controla el acceso a tu panel con roles." La funcionalidad RBAC está disponible en el [plan Enterprise](https://mintlify.com/pricing?ref=rbac). -Mintlify ofrece dos niveles de acceso al panel: Editor y Administrador. +Mintlify ofrece dos niveles de acceso al panel: Editor y Admin. -A continuación se detallan las acciones restringidas al rol de Administrador: +A continuación se describen las acciones restringidas al rol de Admin: -| | Editor | Administrador | -| ----------------------- | :----: | :-----------: | -| Actualizar roles de usuario | ❌ | ✅ | -| Eliminar usuarios | ❌ | ✅ | -| Invitar usuarios administradores | ❌ | ✅ | -| Gestionar y actualizar la facturación | ❌ | ✅ | -| Actualizar el dominio personalizado | ❌ | ✅ | -| Actualizar la fuente de Git | ❌ | ✅ | -| Eliminar la organización | ❌ | ✅ | +| | Editor | Admin | +| ----------------------- | :----: | :---: | +| Actualizar roles de usuario | ❌ | ✅ | +| Eliminar usuarios | ❌ | ✅ | +| Invitar usuarios admin | ❌ | ✅ | +| Gestionar y actualizar la facturación | ❌ | ✅ | +| Actualizar dominio personalizado | ❌ | ✅ | +| Actualizar origen de Git | ❌ | ✅ | +| Eliminar organización | ❌ | ✅ | -Las demás acciones del panel están disponibles para ambos roles. +El resto de acciones del panel están disponibles para ambos roles. -Puedes invitar a tantos administradores como quieras, pero recomendamos limitar el acceso de administrador a los usuarios que lo necesiten. +Puedes invitar a tantos admins como quieras, pero recomendamos limitar el acceso de admin a quienes realmente lo necesiten. diff --git a/es/advanced/dashboard/sso.mdx b/es/advanced/dashboard/sso.mdx index 41e315aae..ba109dd6d 100644 --- a/es/advanced/dashboard/sso.mdx +++ b/es/advanced/dashboard/sso.mdx @@ -1,16 +1,14 @@ --- title: "Inicio de sesión único (SSO)" -description: "Personaliza cómo tu equipo puede iniciar sesión en el panel de administración" +description: "Personaliza cómo puede iniciar sesión tu equipo en el panel de administración" --- - La funcionalidad de SSO está disponible en el [plan Enterprise](https://mintlify.com/pricing?ref=sso). + La función de SSO está disponible en el [plan Enterprise](https://mintlify.com/pricing?ref=sso). Usa el inicio de sesión único en tu panel mediante SAML y OIDC. Si usas Okta, Google Workspace o Microsoft Entra, contamos con documentación específica del proveedor para configurar SSO. Si usas otro proveedor, [contáctanos](mailto:support@mintlify.com). - -
## Okta
@@ -18,13 +16,13 @@ Usa el inicio de sesión único en tu panel mediante SAML y OIDC. Si usas Okta, - - En `Applications`, haz clic para crear una nueva integración de aplicación usando SAML 2.0. + + 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) + * Audience URI (proporcionado por Mintlify) * Name ID Format: `EmailAddress` * Attribute Statements: | Name | Name format | Value @@ -32,31 +30,29 @@ Usa el inicio de sesión único en tu panel mediante SAML y OIDC. Si usas Okta, | `firstName` | Basic | `user.firstName` | | `lastName` | Basic | `user.lastName` | - - Una vez configurada la aplicación, ve a la pestaña de inicio de sesión y envíanos la URL de metadatos. - Habilitaremos la conexión por nuestra parte usando esta información. + + Una vez que la aplicación esté configurada, ve a la pestaña Sign On y envíanos la metadata URL. + Habilitaremos la conexión desde nuestro lado con esta información. - - En `Applications`, haz clic para crear una nueva integración de aplicación usando OIDC. + + 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 e ingresa la Redirect URI proporcionada por Mintlify. + + Selecciona el grant type Authorization Code e ingresa la Redirect URI proporcionada por Mintlify. - - Una vez configurada la aplicación, ve a la pestaña General y localiza el client ID y el client secret. - Por favor, proporciónanos ambos de forma segura, junto con la URL de tu instancia de Okta (p. ej., `.okta.com`). Puedes enviarlos mediante un servicio como 1Password o SendSafely. + + Una vez que la aplicación esté configurada, ve a la pestaña General y localiza el client ID y el client secret. + Proporciónanos esta información de forma segura, junto con la URL de tu instancia de Okta (por ejemplo, `.okta.com`). Puedes enviarla mediante un servicio como 1Password o SendSafely. - -
## Google Workspace
@@ -71,14 +67,14 @@ Usa el inicio de sesión único en tu panel mediante SAML y OIDC. Si usas Okta, - Copia la SSO URL, el Entity ID y el certificado x509 proporcionados y envíalos al equipo de Mintlify. + Copia la URL de SSO, el Entity ID y el certificado x509 proporcionados y envíalos al equipo de Mintlify. ![](/images/gsuite-saml-metadata.png) - En la página Service provider details, introduce lo siguiente: - * ACS URL (proporcionado por Mintlify) + En la página Service provider details, ingresa lo siguiente: + * ACS URL (proporcionada por Mintlify) * Entity ID (proporcionado por Mintlify) * Name ID format: `EMAIL` * Name ID: `Basic Information > Primary email` @@ -87,7 +83,7 @@ Usa el inicio de sesión único en tu panel mediante SAML y OIDC. Si usas Okta, ![](/images/gsuite-sp-details.png) - En la siguiente página, introduce las siguientes declaraciones de atributos: + En la página siguiente, ingresa las siguientes declaraciones de atributos: | Google Directory Attribute | App Attribute | | -------------------------- | ------------- | | `First name` | `firstName` | @@ -99,8 +95,6 @@ Usa el inicio de sesión único en tu panel mediante SAML y OIDC. Si usas Okta, - -
## Microsoft Entra
@@ -115,7 +109,7 @@ Usa el inicio de sesión único en tu panel mediante SAML y OIDC. Si usas Okta, Ve a la página de configuración de Single Sign-On 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. + * Reply URL (Assertion Consumer Service URL): la ACS URL proporcionada por Mintlify. Deja los demás valores en blanco y selecciona **Save**. @@ -123,7 +117,7 @@ Usa el inicio de sesión único en tu panel mediante SAML y OIDC. Si usas Okta, Edita la sección Attributes & Claims: 1. Selecciona **Unique User Identifier (Name ID)** en "Required Claim". 2. Cambia el Source attribute para usar `user.primaryauthoritativeemail`. - 3. En Additional claims, crea los siguientes claims: + 3. En Additional claims, crea las siguientes claims: | Name | Value | | ---- | ----- | | `firstName` | `user.givenname` | @@ -131,11 +125,11 @@ Usa el inicio de sesión único en tu panel mediante SAML y OIDC. Si usas Okta, 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 de nuestro lado usando esta información. + 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 panel. - + \ No newline at end of file diff --git a/es/advanced/subpath/cloudflare.mdx b/es/advanced/subpath/cloudflare.mdx index 45b9f0e72..023cc97bf 100644 --- a/es/advanced/subpath/cloudflare.mdx +++ b/es/advanced/subpath/cloudflare.mdx @@ -8,7 +8,7 @@ import Propagating from "/snippets/es/custom-subpath-propagating.mdx"; Para alojar tu documentación en una subruta personalizada como `yoursite.com/docs` con Cloudflare, deberás crear y configurar un Cloudflare Worker. - Antes de empezar, necesitas una cuenta de Cloudflare y un nombre de dominio (puede administrarse dentro o fuera de Cloudflare). + Antes de comenzar, necesitas una cuenta de Cloudflare y un nombre de dominio (que puede gestionarse dentro o fuera de Cloudflare). @@ -16,51 +16,51 @@ Para alojar tu documentación en una subruta personalizada como `yoursite.com/do ## Estructura del repositorio -Los archivos de documentación deben organizarse dentro del repositorio para que coincidan con la subruta elegida. Por ejemplo, si quieres que tu documentación esté en `yoursite.com/docs`, crea un directorio `docs/` con todos los archivos de documentación. +Los archivos de documentación deben organizarse dentro del repositorio para que coincidan con la estructura de subruta que elijas. Por ejemplo, si deseas que tu documentación esté en `yoursite.com/docs`, crea un directorio `docs/` con todos los archivos de documentación.
- ## Configurar un Cloudflare Worker + ## Configura un Cloudflare Worker
-Crea un Cloudflare Worker siguiendo la [guía de inicio de Cloudflare Workers](https://developers.cloudflare.com/workers/get-started/dashboard/) si aún no lo has hecho. +Crea un Cloudflare Worker siguiendo la [guía de inicio de Cloudflare Workers](https://developers.cloudflare.com/workers/get-started/dashboard/), si aún no lo has hecho. - Si tu proveedor de DNS es Cloudflare, no habilites el proxy para el registro CNAME. + Si tu proveedor de DNS es Cloudflare, no uses el proxy para el registro CNAME.
### Proxies con implementaciones de Vercel
-Si usas Cloudflare como proxy con implementaciones de Vercel, asegúrate de configurarlo correctamente para evitar conflictos con la verificación de dominio de Vercel y el aprovisionamiento de certificados SSL. +Si usas Cloudflare como proxy con implementaciones de Vercel, debes asegurarte de configurarlo correctamente para evitar conflictos con la verificación de dominio de Vercel y la emisión de certificados SSL. Una configuración de proxy incorrecta puede impedir que Vercel emita certificados SSL de Let's Encrypt y provocar errores en la verificación de dominio.
- #### Lista de rutas permitidas obligatoria + #### Lista de rutas permitidas requerida
Tu Cloudflare Worker debe permitir el tráfico a estas rutas específicas sin bloquear ni redirigir: -- `/.well-known/acme-challenge/*` - Necesario para la verificación del certificado de Let's Encrypt -- `/.well-known/vercel/*` - Necesario para la verificación de dominios en Vercel +- `/.well-known/acme-challenge/*` - Obligatorio para la verificación de certificados de Let's Encrypt +- `/.well-known/vercel/*` - Obligatorio para la verificación de dominios de Vercel -Si bien Cloudflare gestiona automáticamente muchas reglas de verificación, crear reglas personalizadas adicionales podría bloquear inadvertidamente este tráfico crítico. +Aunque Cloudflare gestiona automáticamente muchas reglas de verificación, crear reglas personalizadas adicionales puede bloquear inadvertidamente este tráfico crítico.
#### Requisitos para el reenvío de encabezados
-Asegúrate de que el encabezado `HOST` se reenvíe correctamente en la configuración de tu Worker. Si los encabezados no se reenvían correctamente, las solicitudes de verificación fallarán. +Asegúrate de que el encabezado `HOST` se reenvíe correctamente en la configuración de tu Worker. Si los encabezados no se reenvían adecuadamente, las solicitudes de verificación fallarán.
### Configurar el enrutamiento
-En tu panel de Cloudflare, selecciona **Edit Code** y agrega el siguiente script en el código de tu Worker. Consulta la [documentación de Cloudflare](https://developers.cloudflare.com/workers-ai/get-started/dashboard/#development) para obtener más información sobre cómo editar un Worker. +En tu panel de Cloudflare, selecciona **Edit Code** y agrega el siguiente script al código de tu Worker. Consulta la [documentación de Cloudflare](https://developers.cloudflare.com/workers-ai/get-started/dashboard/#development) para obtener más información sobre cómo editar un Worker. - Reemplaza `[SUBDOMAIN]` por tu subdominio único, `[YOUR_DOMAIN]` por la URL base de tu sitio web y `/docs` por la subruta que prefieras si fuera distinta. + Reemplaza `[SUBDOMAIN]` por tu subdominio único, `[YOUR_DOMAIN]` por la URL base de tu sitio web y `/docs` por la subruta que desees si es diferente. ```javascript @@ -72,14 +72,14 @@ async function handleRequest(request) { try { const urlObject = new URL(request.url); - // Si la solicitud es a una ruta de verificación de Vercel, deja que pase + // Si la solicitud es a una ruta de verificación de Vercel, déjala pasar if (urlObject.pathname.startsWith('/.well-known/')) { return await fetch(request); } - // Si la solicitud es al subdirectorio de docs + // Si la solicitud es al subdirectorio /docs if (/^\/docs/.test(urlObject.pathname)) { - // Entonces, haz proxy a Mintlify + // Entonces hacer proxy a Mintlify const DOCS_URL = "[SUBDOMAIN].mintlify.dev"; const CUSTOM_URL = "[YOUR_DOMAIN]"; @@ -91,13 +91,13 @@ async function handleRequest(request) { proxyRequest.headers.set("Host", DOCS_URL); proxyRequest.headers.set("X-Forwarded-Host", CUSTOM_URL); proxyRequest.headers.set("X-Forwarded-Proto", "https"); - // Si despliegas en Vercel, conserva la IP del cliente + // Si estás desplegando en Vercel, conserva la IP del cliente proxyRequest.headers.set("CF-Connecting-IP", request.headers.get("CF-Connecting-IP")); return await fetch(proxyRequest); } } catch (error) { - // Si no se encuentra ninguna coincidencia, procesa la solicitud normal + // Si no se encuentra ninguna coincidencia, realizar la solicitud normal return await fetch(request); } } @@ -118,7 +118,7 @@ Después de desplegar tu código, prueba tu Worker para asegurarte de que rediri 2. Verifica que el Worker redirige a tu documentación de Mintlify y a tu sitio web.
- ### Agregar dominio personalizado + ### Agregar un dominio personalizado
1. En tu [panel de Cloudflare](https://dash.cloudflare.com/), ve a tu Worker. @@ -126,36 +126,36 @@ Después de desplegar tu código, prueba tu Worker para asegurarte de que rediri 3. Agrega tu dominio. - Recomendamos agregar tu dominio tanto con `www.` como sin él. + Recomendamos agregar tu dominio tanto con como sin `www.`. -Consulta [Add a custom domain](https://developers.cloudflare.com/workers/configuration/routing/custom-domains/#add-a-custom-domain) en la documentación de Cloudflare para más información. +Consulta [Add a custom domain](https://developers.cloudflare.com/workers/configuration/routing/custom-domains/#add-a-custom-domain) en la documentación de Cloudflare para obtener más información.
### Resolver conflictos de DNS
-Si tu dominio ya apunta a otro servicio, debes eliminar el registro DNS existente. Tu Cloudflare Worker debe estar configurado para controlar todo el tráfico de tu dominio. +Si tu dominio ya apunta a otro servicio, debes eliminar el registro DNS existente. Tu Cloudflare Worker debe estar configurado para gestionar todo el tráfico de tu dominio. -1. Elimina el registro DNS existente de tu dominio. Consulta [Eliminar registros DNS](https://developers.cloudflare.com/dns/manage-dns-records/how-to/create-dns-records/#delete-dns-records) en la documentación de Cloudflare para obtener más información. -2. Regresa a tu Worker y añade tu dominio personalizado. +1. Elimina el registro DNS existente para tu dominio. Consulta [Delete DNS records](https://developers.cloudflare.com/dns/manage-dns-records/how-to/create-dns-records/#delete-dns-records) en la documentación de Cloudflare para obtener más información. +2. Vuelve a tu Worker y añade tu dominio personalizado.
## Enrutamiento personalizado en Webflow
-Si usas Webflow para alojar tu sitio principal y quieres servir la documentación de Mintlify en `/docs` en el mismo dominio, tendrás que configurar un enrutamiento personalizado mediante Cloudflare Workers para enrutar todo el tráfico que no sea de docs a tu sitio principal. +Si usas Webflow para alojar tu sitio principal y quieres servir la documentación de Mintlify en `/docs` dentro del mismo dominio, tendrás que configurar un enrutamiento personalizado con Cloudflare Workers para enrutar mediante proxy todo el tráfico que no sea de la documentación hacia tu sitio principal. - Asegúrate de que tu sitio principal esté configurado en una página de aterrizaje antes de desplegar este Worker, o quienes visiten tu sitio principal verán errores. + Asegúrate de que tu sitio principal esté configurado en una landing page antes de desplegar este Worker; de lo contrario, los visitantes de tu sitio principal verán errores. -1. En Webflow, configura una página de aterrizaje para tu sitio principal, por ejemplo `landing.yoursite.com`. Esta será la página que verán las personas al visitar tu sitio. -2. Despliega tu sitio principal en la página de aterrizaje. Esto garantiza que tu sitio principal siga siendo accesible mientras configuras el Worker. +1. En Webflow, configura una landing page para tu sitio principal, por ejemplo `landing.yoursite.com`. Esta será la página que verán los visitantes cuando ingresen a tu sitio. +2. Despliega tu sitio principal en la landing page. Esto garantiza que tu sitio principal siga siendo accesible mientras configuras el Worker. 3. Para evitar conflictos, actualiza cualquier URL absoluta en tu sitio principal para que sea relativa. -4. En Cloudflare, selecciona **Edit Code** y añade el siguiente script en el código de tu Worker. +4. En Cloudflare, selecciona **Edit Code** y agrega el siguiente script en el código de tu Worker. - Reemplaza `[SUBDOMAIN]` por tu subdominio único, `[YOUR_DOMAIN]` por la URL base de tu sitio web, `[LANDING_DOMAIN]` por la URL de tu página de aterrizaje y `/docs` por la subruta deseada si fuera distinta. + Reemplaza `[SUBDOMAIN]` con tu subdominio único, `[YOUR_DOMAIN]` con la URL base de tu sitio web, `[LANDING_DOMAIN]` con la URL de tu landing page y `/docs` con la subruta que desees, si es diferente. ```javascript addEventListener("fetch", (event) => { @@ -172,7 +172,7 @@ Si usas Webflow para alojar tu sitio principal y quieres servir la documentació // Si la solicitud es al subdirectorio de docs if (/^\/docs/.test(urlObject.pathname)) { - // Encamina a través de un proxy a Mintlify + // Proxy hacia Mintlify const DOCS_URL = "[SUBDOMAIN].mintlify.dev"; const CUSTOM_URL = "[YOUR_DOMAIN]"; let url = new URL(request.url); @@ -181,11 +181,11 @@ Si usas Webflow para alojar tu sitio principal y quieres servir la documentació proxyRequest.headers.set("Host", DOCS_URL); proxyRequest.headers.set("X-Forwarded-Host", CUSTOM_URL); proxyRequest.headers.set("X-Forwarded-Proto", "https"); - // Si se despliega en Vercel, conserva la IP del cliente + // Si se despliega en Vercel, conservar la IP del cliente proxyRequest.headers.set("CF-Connecting-IP", request.headers.get("CF-Connecting-IP")); return await fetch(proxyRequest); } - // Envía todo lo demás al sitio principal + // Redirige todo lo demás al sitio principal const MAIN_SITE_URL = "[LANDING_DOMAIN]"; if (MAIN_SITE_URL && MAIN_SITE_URL !== "[LANDING_DOMAIN]") { let mainSiteUrl = new URL(request.url); @@ -197,7 +197,7 @@ Si usas Webflow para alojar tu sitio principal y quieres servir la documentació }); } } catch (error) { - // Si no se encuentra ninguna coincidencia, atiende la solicitud normal + // Si no se encuentra ninguna acción, servir la solicitud normal return await fetch(request); } } diff --git a/es/advanced/subpath/route53-cloudfront.mdx b/es/advanced/subpath/route53-cloudfront.mdx index 1ae7d554b..db17b9d3d 100644 --- a/es/advanced/subpath/route53-cloudfront.mdx +++ b/es/advanced/subpath/route53-cloudfront.mdx @@ -1,7 +1,7 @@ --- title: "AWS Route 53 y CloudFront" sidebarTitle: "AWS" -description: "Hospeda la documentación en una subruta personalizada con servicios de AWS" +description: "Aloja la documentación en una subruta personalizada con servicios de AWS" --- import Propagating from "/snippets/es/custom-subpath-propagating.mdx"; @@ -13,43 +13,43 @@ Para alojar tu documentación en una subruta personalizada como `yoursite.com/do ## Estructura del repositorio -Debes organizar los archivos de documentación dentro de tu repositorio para que coincidan con la estructura de subruta que elijas. Por ejemplo, si quieres tu documentación en `yoursite.com/docs`, crea un directorio `docs/` con todos los archivos de documentación. +Los archivos de documentación deben organizarse en tu repositorio para ajustarse a la estructura de subruta que elijas. Por ejemplo, si quieres que tu documentación esté en `yoursite.com/docs`, crea un directorio `docs/` con todos tus archivos de documentación.
- ## Descripción general de alto nivel + ## Descripción general
-Enruta el tráfico a estas rutas con una política de caché **CachingDisabled**: +Encamina el tráfico a estas rutas con una política de caché **CachingDisabled**: - `/.well-known/acme-challenge/*` - Requerido para la verificación de certificados de Let's Encrypt - `/.well-known/vercel/*` - Requerido para la verificación de dominio - `/docs/*` - Requerido para el enrutamiento por subruta - `/docs/` - Requerido para el enrutamiento por subruta -Enruta el tráfico a esta ruta con una política de caché **CachingEnabled**: +Encamina el tráfico a esta ruta con una política de caché **CachingEnabled**: - `/mintlify-assets/_next/static/*` - `Default (*)` - La página de inicio de tu sitio web Todos los comportamientos deben tener una **política de solicitud de origen** de `AllViewerExceptHostHeader`. -![Página de "Behaviors" de CloudFront con 4 comportamientos: `/docs/*`, `/docs`, `Default` y `/.well-known/*`.](/images/cloudfront/all-behaviors.png) +![CloudFront "Behaviors" page with 4 behaviors: `/docs/*`, `/docs`, `Default`, and `/.well-known/*`.](/images/cloudfront/all-behaviors.png)
## Crear una distribución de CloudFront
-1. Ve a [CloudFront](https://aws.amazon.com/cloudfront) desde la consola de AWS. +1. Ve a [CloudFront](https://aws.amazon.com/cloudfront) en la consola de AWS. 2. Selecciona **Create distribution**. - ![Página de distribuciones de CloudFront con el botón "Create distribution" resaltado.](/images/cloudfront/create-distribution.png) + ![Página de CloudFront Distributions con el botón "Create distribution" resaltado.](/images/cloudfront/create-distribution.png) 3. En Origin domain, ingresa `[SUBDOMAIN].mintlify.dev`, donde `[SUBDOMAIN]` es el subdominio único de tu proyecto. - ![Página "Create distribution" de CloudFront mostrando "acme.mintlify.dev" como el dominio de origen.](/images/cloudfront/origin-name.png) + ![Página de CloudFront "Create distribution" que muestra "acme.mintlify.dev" como el dominio de origen.](/images/cloudfront/origin-name.png) 4. En "Web Application Firewall (WAF)", habilita las protecciones de seguridad. @@ -58,7 +58,7 @@ Todos los comportamientos deben tener una **política de solicitud de origen** d ![Opciones de Web Application Firewall (WAF) con "Enable security protections" seleccionado.](/images/cloudfront/enable-security-protections.png) -5. Deja el resto de los ajustes con sus valores predeterminados. +5. Deja el resto de la configuración con los valores predeterminados. 6. Selecciona **Create distribution**.
@@ -95,10 +95,10 @@ A este punto, deberías tener dos Origins: uno con `[SUBDOMAIN].mintlify.app` y ## Configurar comportamientos
-Los comportamientos en CloudFront permiten controlar la lógica de las subrutas. A alto nivel, buscamos crear la siguiente lógica: +Los comportamientos en CloudFront permiten controlar la lógica de subrutas. A alto nivel, queremos crear la siguiente lógica: - **Si un usuario llega a tu subruta personalizada**, ir a `[SUBDOMAIN].mintlify.dev`. -- **Si un usuario llega a cualquier otra página**, ir a la página de destino actual. +- **Si un usuario llega a cualquier otra página**, ir a la página de inicio actual. 1. Navega a la pestaña "Behaviors" de tu distribución de CloudFront. @@ -112,17 +112,17 @@ Los comportamientos en CloudFront permiten controlar la lógica de las subrutas. ### `/.well-known/*` -Crea comportamientos para las rutas de verificación de dominio de Vercel con un **Patrón de ruta** de `/.well-known/*` y configura **Origen y grupos de orígenes** a la URL de tu documentación. +Crea comportamientos para las rutas de verificación de dominios de Vercel con un **Patrón de ruta** `/.well-known/*` y configura **Origin and origin groups** a la URL de tu documentación. -Para "Política de caché", selecciona **CachingDisabled** para garantizar que estas solicitudes de verificación se transmitan sin almacenamiento en caché. +Para "Cache policy", selecciona **CachingDisabled** para que estas solicitudes de verificación pasen sin caché. ![Página de CloudFront "Create behavior" con un "Path pattern" de "/.well-known/*" y "Origin and origin groups" apuntando a la URL de staging.](/images/cloudfront/well-known-policy.png) -Si `.well-known/*` es demasiado genérico, se puede acotar a un mínimo de 2 comportamientos para Vercel: - - `/.well-known/vercel/*` - Requerido para la verificación de dominio de Vercel +Si `.well-known/*` es demasiado genérico, puedes reducirlo a un mínimo de 2 comportamientos para Vercel: + - `/.well-known/vercel/*` - Requerido para la verificación de dominios de Vercel - `/.well-known/acme-challenge/*` - Requerido para la verificación de certificados de Let's Encrypt @@ -130,11 +130,11 @@ Si `.well-known/*` es demasiado genérico, se puede acotar a un mínimo de 2 com ### Tu subruta personalizada -Crea un comportamiento con un **patrón de ruta** para la subruta que elijas, por ejemplo `/docs`, con **origen y grupos de origen** apuntando a la URL `.mintlify.dev` (en nuestro caso `acme.mintlify.dev`). +Crea un comportamiento con un **Patrón de ruta** de la subruta que elijas, por ejemplo `/docs`, con **Origen y grupos de origen** apuntando a la URL `.mintlify.dev` (en nuestro caso `acme.mintlify.dev`). -- Configura "Cache policy" como **CachingOptimized**. -- Configura "Origin request policy" como **AllViewerExceptHostHeader**. -- Configura "Viewer Protocol Policy" como **Redirect HTTP to HTTPS**. +- Configura "Cache policy" en **CachingOptimized**. +- Configura "Origin request policy" en **AllViewerExceptHostHeader**. +- Configura "Viewer Protocol Policy" en **Redirect HTTP to HTTPS**. ![Página de CloudFront "Create behavior" con un "Path pattern" de "/docs/*" y "Origin and origin groups" apuntando a la URL `acme.mintlify.dev`.](/images/cloudfront/behavior-1.png) @@ -144,21 +144,21 @@ Crea un comportamiento con un **patrón de ruta** para la subruta que elijas, po ### Tu subruta personalizada con comodín -Crea un comportamiento con un **Patrón de ruta** de la subruta elegida seguida de `/*`, por ejemplo `/docs/*`, y **Origen y grupos de origen** que apunten a la misma URL `.mintlify.dev`. +Crea un comportamiento con un **patrón de ruta** de la subruta que elijas seguida de `/*`, por ejemplo `/docs/*`, y **origen y grupos de origen** que apunten a la misma URL `.mintlify.dev`. -Estos ajustes deben coincidir exactamente con el comportamiento de tu subruta base, con la excepción del **Patrón de ruta**. +Estos ajustes deben coincidir exactamente con el comportamiento de tu subruta base, con la excepción del **patrón de ruta**. -- Establece "Cache policy" en **CachingOptimized**. -- Establece "Origin request policy" en **AllViewerExceptHostHeader**. -- Establece "Viewer protocol policy" en **Redirect HTTP to HTTPS**. +- Configura "Cache policy" como **CachingOptimized**. +- Configura "Origin request policy" como **AllViewerExceptHostHeader**. +- Configura "Viewer protocol policy" como **Redirect HTTP to HTTPS**.
### `/mintlify-assets/_next/static/*`
-- Establece "Cache policy" en **CachingOptimized** - - Establece "Origin request policy" en **AllViewerExceptHostHeader** - - Establece "Viewer protocol policy" en **Redirect HTTP to HTTPS** +- Establece la "Cache policy" en **CachingOptimized** + - Establece la "Origin request policy" en **AllViewerExceptHostHeader** + - Establece la "Viewer protocol policy" en **Redirect HTTP to HTTPS**
### `Default (*)` @@ -173,7 +173,7 @@ Por último, vamos a editar el comportamiento `Default (*)`. 1. Cambia **Origin and origin groups** del comportamiento predeterminado a la URL de staging (en nuestro caso, `mintlify-landing-page.vercel.app`). - ![Página de CloudFront "Edit behavior" con el campo "Origin and origin groups" resaltado.](/images/cloudfront/default-behavior-2.png) + ![Página de CloudFront "Edit behavior" con el campo de entrada "Origin and origin groups" resaltado.](/images/cloudfront/default-behavior-2.png) 2. Selecciona **Save changes**. @@ -192,24 +192,24 @@ Si sigues los pasos anteriores, tus comportamientos deberían verse así: ## Vista previa de la distribución
-Ahora puedes verificar si tu distribución está configurada correctamente yendo a la pestaña «General» y visitando la URL **Distribution domain name**. +Ahora puedes comprobar si tu distribución está configurada correctamente yendo a la pestaña "General" y visitando la URL de **Distribution domain name**. - ![Pestaña «General» de CloudFront con la URL «Distribution domain name» resaltada.](/images/cloudfront/preview-distribution.png) + ![Pestaña "General" de CloudFront con la URL de "Distribution domain name" resaltada.](/images/cloudfront/preview-distribution.png) -Todas las páginas deberían dirigirte a tu página principal, pero si agregas la subruta que elegiste, por ejemplo `/docs`, a la URL, deberías ver que te lleva a tu instancia de documentación de Mintlify. +Todas las páginas deberían redirigir a tu página principal, pero si añades la subruta que elegiste, por ejemplo `/docs`, a la URL, deberías ver que te lleva a tu instancia de documentación de Mintlify.
## Conectar con Route53
-Ahora llevaremos la funcionalidad de la distribución de CloudFront a tu dominio principal. +Ahora vamos a llevar la funcionalidad de la distribución de CloudFront a tu dominio principal. - Para esta sección, también puedes consultar la guía oficial de AWS: [Configuring - Amazon Route 53 to route traffic to a CloudFront - distribution](https://docs.aws.amazon.com/Route53/latest/DeveloperGuide/routing-to-cloudfront-distribution.html#routing-to-cloudfront-distribution-config) + Para esta sección, también puedes consultar la guía oficial de AWS sobre [Configurar + Amazon Route 53 para enrutar tráfico a una + distribución de CloudFront](https://docs.aws.amazon.com/Route53/latest/DeveloperGuide/routing-to-cloudfront-distribution.html#routing-to-cloudfront-distribution-config) 1. Ve a [Route53](https://aws.amazon.com/route53) en la consola de AWS. @@ -217,10 +217,10 @@ Ahora llevaremos la funcionalidad de la distribución de CloudFront a tu dominio 3. Selecciona **Create record**. - ![Página “Records” de Route 53 con el botón “Create record” destacado.](/images/cloudfront/route53-create-record.png) + ![Página “Records” de Route 53 con el botón “Create record” resaltado.](/images/cloudfront/route53-create-record.png) -4. Activa `Alias` y luego, en **Route traffic to**, elige la opción `Alias to CloudFront distribution`. +4. Activa `Alias` y luego, en **Route traffic to**, selecciona la opción `Alias to CloudFront distribution`. ![Página “Create record” de Route 53 con el interruptor “Alias” y el menú “Route traffic to” resaltados.](/images/cloudfront/create-record-alias.png) @@ -232,6 +232,6 @@ Ahora llevaremos la funcionalidad de la distribución de CloudFront a tu dominio Es posible que debas eliminar el registro A existente si ya hay uno. -Tu documentación ya está disponible en la subruta que elegiste para tu dominio principal. +Tu documentación ahora está activa en la subruta elegida de tu dominio principal. \ No newline at end of file diff --git a/es/advanced/subpath/vercel.mdx b/es/advanced/subpath/vercel.mdx index 1215d8fbf..32a51d52b 100644 --- a/es/advanced/subpath/vercel.mdx +++ b/es/advanced/subpath/vercel.mdx @@ -10,11 +10,11 @@ import { VercelJsonGenerator } from "/snippets/es/vercel-json-generator.mdx"; ## archivo vercel.json -El archivo `vercel.json` define cómo se compila y se implementa tu proyecto. Se ubica en el directorio raíz y controla varios aspectos de la implementación, incluido el enrutamiento, las redirecciones, los encabezados y la configuración de compilación. +El archivo `vercel.json` define cómo se crea y se despliega tu proyecto. Se encuentra en el directorio raíz y controla varios aspectos del despliegue, incluidos el ruteo, las redirecciones, los encabezados y la configuración de compilación. -Usamos la opción `rewrites` para hacer de proxy y enrutar solicitudes desde tu dominio principal hacia tu documentación. +Usamos la opción `rewrites` para reenviar (proxy) solicitudes desde tu dominio principal hacia tu documentación. -Los rewrites mapean solicitudes entrantes a destinos distintos sin cambiar la URL en el navegador. Cuando alguien visita `yoursite.com/docs`, Vercel obtendrá internamente el contenido de `your-subdomain.mintlify.dev/docs`, pero el usuario seguirá viendo `yoursite.com/docs` en su navegador. Esto difiere de las redirecciones, que enviarían a los usuarios a una URL completamente diferente. +Las reglas de reescritura asignan solicitudes entrantes a otros destinos sin cambiar la URL en el navegador. Cuando alguien visita `yoursite.com/docs`, Vercel obtendrá internamente contenido de `your-subdomain.mintlify.dev/docs`, pero el usuario seguirá viendo `yoursite.com/docs` en su navegador. Esto es diferente de las redirecciones, que enviarían a los usuarios a una URL completamente distinta. Puedes personalizar la subruta con cualquier valor que prefieras, como `/docs`, `/help` o `/guides`. Además, puedes usar subrutas con varios niveles, como `/product/docs`. @@ -22,13 +22,13 @@ Puedes personalizar la subruta con cualquier valor que prefieras, como `/docs`, ## Estructura del repositorio -Los archivos de documentación deben organizarse dentro del repositorio para que coincidan con la estructura de subruta que elijas. Por ejemplo, si quieres que tu documentación esté en `yoursite.com/docs`, crea un directorio `docs/` con todos los archivos de documentación. +Tus archivos de documentación deben organizarse dentro de tu repositorio para ajustarse a la estructura de subruta que elijas. Por ejemplo, si quieres que tu documentación esté en `yoursite.com/docs`, crea un directorio `docs/` con todos tus archivos de documentación.
## Configuración
-Para alojar tu documentación en una subruta personalizada con Vercel, añade la siguiente configuración a tu archivo `vercel.json`. Este ejemplo usa `/docs`, pero puedes sustituirlo por cualquier subruta: +Para alojar tu documentación en una subruta personalizada con Vercel, añade la siguiente configuración a tu archivo `vercel.json`. Este ejemplo usa `/docs`, pero puedes reemplazarlo por cualquier subruta: ```json { @@ -46,8 +46,8 @@ Para alojar tu documentación en una subruta personalizada con Vercel, añade la ``` * **`source`**: El patrón de ruta en tu dominio que activa la reescritura. -* **`destination`**: Adonde se debe enviar la solicitud mediante proxy. -* **`:match*`**: Un comodín que captura cualquier segmento de la ruta después de tu subruta. +* **`destination`**: A dónde se debe enrutar la solicitud mediante proxy. +* **`:match*`**: Un comodín que captura cualquier segmento de ruta después de tu subruta. Para obtener más información, consulta [Configuring projects with vercel.json: Rewrites](https://vercel.com/docs/projects/project-configuration#rewrites) en la documentación de Vercel. @@ -56,7 +56,7 @@ Para obtener más información, consulta [Configuring projects with vercel.json: ### Generar redirecciones -Ingresa tu subdominio y subdirectorio personalizado para generar las redirecciones para tu archivo `vercel.json`. +Ingresa tu subdominio y subdirectorio personalizado para generar las reglas en tu archivo `vercel.json`. @@ -64,21 +64,21 @@ Ingresa tu subdominio y subdirectorio personalizado para generar las redireccion ## Uso de proxies externos con Vercel -Si utilizas un proxy externo (como Cloudflare o AWS CloudFront) delante de tu despliegue en Vercel, debes configurarlo correctamente para evitar conflictos con la verificación de dominios de Vercel y la emisión de certificados SSL. +Si utilizas un proxy externo (como Cloudflare o AWS CloudFront) delante de tu implementación en Vercel, debes configurarlo correctamente para evitar conflictos con la verificación de dominio de Vercel y la provisión de certificados SSL. -Una configuración incorrecta del proxy puede impedir que Vercel emita certificados SSL de Let's Encrypt y provocar errores en la verificación de dominio. +Una configuración incorrecta del proxy puede impedir que Vercel emita certificados SSL de Let's Encrypt y provocar fallos en la verificación de dominio. -Consulta los [proveedores admitidos](https://vercel.com/guides/how-to-setup-verified-proxy#supported-providers-verified-proxy-lite) en la documentación de Vercel. +Consulta los [proveedores compatibles](https://vercel.com/guides/how-to-setup-verified-proxy#supported-providers-verified-proxy-lite) en la documentación de Vercel.
- ### Lista de rutas permitidas obligatoria + ### Lista de rutas permitidas requerida
-Tu proxy externo debe permitir el tráfico a estas rutas específicas sin bloquear, redirigir ni aplicar caché agresiva: +Tu proxy externo debe permitir el tráfico a estas rutas específicas sin bloquear, redirigir ni aplicar caché de forma agresiva: -- `/.well-known/acme-challenge/*` - Necesaria para la verificación de certificados de Let's Encrypt -- `/.well-known/vercel/*` - Necesaria para la verificación de dominios de Vercel -- `/mintlify-assets/_next/static/*` - Necesaria para los recursos estáticos +- `/.well-known/acme-challenge/*` - Necesario para la verificación de certificados de Let's Encrypt +- `/.well-known/vercel/*` - Necesario para la verificación de dominios de Vercel +- `/mintlify-assets/_next/static/*` - Necesario para los recursos estáticos Estas rutas deben pasar directamente a tu despliegue en Vercel sin modificaciones. @@ -86,14 +86,14 @@ Estas rutas deben pasar directamente a tu despliegue en Vercel sin modificacione ### Requisitos para el reenvío de encabezados -Asegúrate de que tu proxy reenvíe correctamente el encabezado `HOST`. Sin un reenvío adecuado de este encabezado, las solicitudes de verificación fallarán. +Asegúrate de que tu proxy reenvíe correctamente el encabezado `HOST`. Sin un reenvío adecuado de ese encabezado, las solicitudes de verificación fallarán.
- ### Prueba de la configuración de tu proxy + ### Probar la configuración del proxy
Para verificar que tu proxy esté configurado correctamente: 1. Comprueba que `https://[yourdomain].com/.well-known/vercel/` devuelva una respuesta. 2. Asegúrate de que los certificados SSL se estén aprovisionando correctamente en tu panel de Vercel. -3. Verifica que la verificación de dominio se complete correctamente. \ No newline at end of file +3. Verifica que la verificación del dominio se complete correctamente. \ No newline at end of file diff --git a/es/ai/contextual-menu.mdx b/es/ai/contextual-menu.mdx index 2759bec4a..c425f8269 100644 --- a/es/ai/contextual-menu.mdx +++ b/es/ai/contextual-menu.mdx @@ -7,19 +7,19 @@ icon: "square-menu" import { PreviewButton } from "/snippets/previewbutton.jsx" import IconsRequired from "/snippets/es/icons-required.mdx"; -El menú contextual ofrece acceso rápido a contenido optimizado para IA e integraciones directas con herramientas de IA populares. Cuando los usuarios abren el menú contextual en cualquier página, pueden copiar contenido para usarlo como contexto en herramientas de IA o iniciar conversaciones en ChatGPT, Claude, Perplexity o una herramienta personalizada de su elección, con su documentación ya cargada como contexto. +El menú contextual ofrece acceso rápido a contenido optimizado para IA e integraciones directas con herramientas de IA populares. Cuando los usuarios abren el menú contextual en cualquier página, pueden copiar contenido para usarlo como contexto en herramientas de IA o iniciar conversaciones en ChatGPT, Claude, Perplexity o en una herramienta personalizada de su elección, con su documentación ya cargada como contexto. -El menú contextual incluye varias opciones prediseñadas que puedes habilitar agregando su identificador a tu configuración. +El menú contextual incluye varias opciones predefinidas que puedes habilitar agregando su identificador a tu configuración. | Opción | Identificador | Descripción | |:--------|:------------|:-------------| -| **Copiar página** | `copy` | Copia la página actual como Markdown para pegarla como contexto en herramientas de IA | -| **Ver como Markdown** | `view` | Abre la página actual como Markdown | +| **Copiar página** | `copy` | Copia la página actual en formato Markdown para pegarla como contexto en herramientas de IA | +| **Ver como Markdown** | `view` | Abre la página actual en formato Markdown | | **Abrir en ChatGPT** | `chatgpt` | Crea una conversación en ChatGPT con la página actual como contexto | | **Abrir en Claude** | `claude` | Crea una conversación en Claude con la página actual como contexto | | **Abrir en Perplexity** | `perplexity` | Crea una conversación en Perplexity con la página actual como contexto | @@ -115,7 +115,7 @@ Ejemplo de opción personalizada: "perplexity", { "title": "Solicitar una función", - "description": "Únete a la conversación en GitHub para pedir una nueva función" + "description": "Únete a la conversación en GitHub para solicitar una nueva función" "icon": "plus", "href": "https://github.com/orgs/mintlify/discussions/categories/feature-requests" } @@ -134,7 +134,7 @@ Ejemplo de opción personalizada: ```json { "title": "Solicitar una función", - "description": "Únete a la discusión en GitHub", + "description": "Únete a la conversación en GitHub", "icon": "plus", "href": "https://github.com/orgs/mintlify/discussions/categories/feature-requests" } diff --git a/es/ai/llmstxt.mdx b/es/ai/llmstxt.mdx index d37397938..cdf3ed881 100644 --- a/es/ai/llmstxt.mdx +++ b/es/ai/llmstxt.mdx @@ -1,50 +1,48 @@ --- title: "llms.txt" -description: "Facilita que los LLM lean e indexen tu contenido" +description: "Facilita que los LLMs lean e indexen tu contenido" icon: "file-code" --- import { PreviewButton } from "/snippets/previewbutton.jsx" -El [archivo llms.txt](https://llmstxt.org) es un estándar del sector que ayuda a los LLM a indexar contenido de forma más eficiente, similar a cómo un sitemap ayuda a los motores de búsqueda. Las herramientas de IA pueden usar este archivo para comprender la estructura de tu documentación y encontrar contenido relevante para las consultas de los usuarios. +El [archivo llms.txt](https://llmstxt.org) es un estándar del sector que ayuda a los LLM a indexar contenido de forma más eficiente, de manera similar a como un sitemap ayuda a los motores de búsqueda. Las herramientas de IA pueden usar este archivo para entender la estructura de tu documentación y encontrar contenido relevante para las consultas de los usuarios. -Mintlify aloja automáticamente un archivo `llms.txt` en la raíz de tu proyecto que enumera todas las páginas disponibles de tu documentación. Este archivo siempre está actualizado y no requiere mantenimiento. De forma opcional, puedes añadir un archivo `llms.txt` personalizado en la raíz de tu proyecto. +Mintlify aloja automáticamente un archivo `llms.txt` en la raíz de tu proyecto que enumera todas las páginas disponibles de tu documentación. Este archivo siempre está actualizado y no requiere mantenimiento. Opcionalmente, puedes añadir un archivo `llms.txt` personalizado en la raíz de tu proyecto. Consulta tu `llms.txt` añadiendo `/llms.txt` a la URL de tu sitio de documentación. Abrir el llms.txt de este sitio. -
## Estructura de llms.txt
Un archivo `llms.txt` es un archivo Markdown sin formato que contiene: -- **Título del sitio** como encabezado H1. -- **Secciones de contenido estructuradas** con enlaces y una descripción de cada página de tu documentación. +* **Título del sitio** como encabezado H1. +* **Secciones de contenido estructurado** con enlaces y una descripción de cada página de tu documentación. -```mdx Example llms.txt -# Example product docs +```mdx Ejemplo de llms.txt +# Documentación de producto de ejemplo -## Guides -- [Getting started](https://example.com/docs/start): Intro guide -- [Install](https://example.com/docs/install): Setup steps +## Guías +- [Primeros pasos](https://example.com/docs/start): Guía introductoria +- [Instalación](https://example.com/docs/install): Pasos de configuración -## Reference -- [API](https://example.com/docs/api): Endpoint list and usage +## Referencia +- [API](https://example.com/docs/api): Lista de endpoints y uso ``` -Este enfoque estructurado permite que los LLM procesen tu documentación de forma eficiente a alto nivel y localicen 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. - +Este enfoque estructurado permite que los LLM procesen tu documentación de forma eficiente a un nivel general y localicen 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
-El archivo `llms-full.txt` combina todo tu sitio de documentación en un solo archivo como contexto para herramientas de IA y lo indexa el tráfico de los LLM. +El archivo `llms-full.txt` combina todo tu sitio de documentación en un solo archivo como contexto para herramientas de IA y es indexado por el tráfico de LLM. Mintlify aloja automáticamente un archivo `llms-full.txt` en la raíz de tu proyecto. Consulta tu `llms-full.txt` agregando `/llms-full.txt` a la URL de tu sitio de documentación. @@ -56,6 +54,6 @@ Mintlify aloja automáticamente un archivo `llms-full.txt` en la raíz de tu pro ## Archivos personalizados -Para agregar un archivo personalizado `llms.txt` o `llms-full.txt`, crea un archivo `llms.txt` o `llms-full.txt` en la raíz de tu proyecto. Al agregar un archivo personalizado, se sobrescribirá el archivo generado automáticamente con el mismo nombre. Si eliminas el archivo personalizado, se volverá a usar el archivo predeterminado. +Para agregar un archivo `llms.txt` o `llms-full.txt` personalizado, crea un archivo `llms.txt` o `llms-full.txt` en la raíz de tu proyecto. Al agregar un archivo personalizado, se reemplazará el archivo generado automáticamente con el mismo nombre. Si eliminas un archivo personalizado, se volverá a usar el archivo predeterminado. -Tu archivo personalizado `llms.txt` o `llms-full.txt` debe incluir el título del sitio como encabezado H1. El resto del contenido es opcional. Consulta [Format](https://llmstxt.org/#format) en la especificación de `llms.txt` para obtener más información sobre las secciones opcionales y las mejores prácticas. +Tu archivo `llms.txt` o `llms-full.txt` personalizado debe incluir el título del sitio como encabezado H1. El resto del contenido es opcional. Consulta [Formato](https://llmstxt.org/#format) en la especificación de `llms.txt` para obtener más información sobre secciones opcionales y buenas prácticas. diff --git a/es/ai/markdown-export.mdx b/es/ai/markdown-export.mdx index 9017470c2..72a84f105 100644 --- a/es/ai/markdown-export.mdx +++ b/es/ai/markdown-export.mdx @@ -1,24 +1,23 @@ --- -title: "Exportación a Markdown" +title: "Exportación de Markdown" description: "Obtén rápidamente versiones en Markdown de las páginas" icon: "file-text" --- import { PreviewButton } from "/snippets/previewbutton.jsx" -Markdown proporciona texto estructurado que las herramientas de IA pueden procesar con mayor eficiencia que HTML, lo que se traduce en respuestas más precisas, tiempos de procesamiento más rápidos y menor consumo de tokens. +Markdown proporciona texto estructurado que las herramientas de IA pueden procesar con mayor eficiencia que HTML, lo que se traduce en respuestas más precisas, tiempos de procesamiento más rápidos y un menor consumo de tokens. Mintlify genera automáticamente versiones en Markdown de las páginas, optimizadas para herramientas de IA e integraciones externas. -
- ## Extensión de URL .md + ## Extensión .md en la URL
-Añade `.md` a la URL de cualquier página para ver una versión en Markdown. +Añade `.md` a la URL de cualquier página para ver su versión en Markdown. -Abrir esta página como Markdown +Abrir esta página en Markdown @@ -26,4 +25,4 @@ Añade `.md` a la URL de cualquier página para ver una versión en Markdown. ## Atajo de teclado -Presiona Command + C (Ctrl + C en Windows) para copiar una página en formato Markdown al portapapeles. +Presiona Command + C (Ctrl + C en Windows) para copiar una página como Markdown al portapapeles. diff --git a/es/ai/model-context-protocol.mdx b/es/ai/model-context-protocol.mdx index 568288234..a5dad59c0 100644 --- a/es/ai/model-context-protocol.mdx +++ b/es/ai/model-context-protocol.mdx @@ -1,6 +1,6 @@ --- title: "Protocolo de Contexto de Modelo" -description: "Permite que los usuarios accedan a tu documentación y a tus API desde sus herramientas de IA favoritas" +description: "Permite que los usuarios accedan a tu documentación y a tus APIs desde sus herramientas de IA favoritas" icon: "audio-waveform" keywords: ["mcp"] --- @@ -11,42 +11,42 @@ import { PreviewButton } from "/snippets/previewbutton.jsx" ## Acerca de los servidores MCP -El Protocolo de Contexto de Modelo (MCP) es un protocolo abierto que crea conexiones estandarizadas entre aplicaciones de IA y servicios externos, como la documentación. Mintlify genera un servidor MCP a partir de tu documentación y de las especificaciones OpenAPI, preparando tu contenido para el ecosistema de IA más amplio, donde cualquier cliente MCP (como Claude, Cursor, Goose y otros) puede conectarse a tu documentación y a tus API. +El MCP (Protocolo de Contexto de Modelo) es un protocolo abierto que crea conexiones estandarizadas entre aplicaciones de IA y servicios externos, como la documentación. Mintlify genera un servidor MCP a partir de tu documentación y especificaciones OpenAPI, preparando tu contenido para el ecosistema de IA más amplio, donde cualquier cliente MCP (como Claude, Cursor, Goose y otros) puede conectarse a tu documentación y a tus API. Tu servidor MCP expone herramientas para que las aplicaciones de IA puedan buscar en tu documentación e interactuar con tus API.
- ## Acceso a tu servidor MCP + ## Acceder a tu servidor MCP
- Los servidores MCP solo pueden generarse para documentación pública. No es posible acceder a documentación protegida por autenticación de usuario final para generar servidores. + Los servidores MCP solo pueden generarse para documentación pública. No es posible acceder a documentación protegida por autenticación de usuario final para generar el servidor. -Mintlify genera automáticamente un servidor MCP para tu documentación y lo aloja en la URL de tu sitio de documentación con la ruta `/mcp`. Por ejemplo, el servidor MCP de Mintlify está disponible en `https://mintlify.com/docs/mcp`. +Mintlify genera automáticamente un servidor MCP para tu documentación y lo aloja en la URL de tu documentación con la ruta `/mcp`. Por ejemplo, el servidor MCP de Mintlify está disponible en `https://mintlify.com/docs/mcp`. Puedes ver y copiar la URL de tu servidor MCP en tu [panel](https://dashboard.mintlify.com/products/mcp). -La ruta `/mcp` está reservada para servidores MCP alojados y no puede usarse para otros elementos de navegación. +La ruta `/mcp` está reservada para servidores MCP alojados y no puede utilizarse para otros elementos de navegación.
- ## Configurar tu servidor MCP + ## Configuring your MCP server
Todos los servidores MCP incluyen la herramienta `search` de forma predeterminada, lo que permite a los usuarios consultar información de tu documentación desde otras herramientas. Si tienes un [plan Pro o Enterprise](https://mintlify.com/pricing?ref=mcp), puedes exponer endpoints de tu especificación OpenAPI como herramientas MCP. -Para exponer endpoints como herramientas MCP, utiliza el objeto `mcp` dentro de la extensión `x-mint`, ya sea a nivel de archivo o de endpoint. Por ejemplo, el servidor MCP de Mintlify incluye herramientas para crear chats del Asistente, obtener actualizaciones de estado y activar actualizaciones. +Para exponer endpoints como herramientas MCP, usa el objeto `mcp` dentro de la extensión `x-mint`, ya sea a nivel de archivo o de endpoint. Por ejemplo, el servidor MCP de Mintlify incluye herramientas para crear chats del Asistente, obtener actualizaciones de estado y desencadenar actualizaciones. -Los servidores MCP siguen un enfoque de seguridad primero en el que los endpoints de la API no se exponen de forma predeterminada. Debes habilitar explícitamente los endpoints para ponerlos a disposición como herramientas MCP. Expón únicamente endpoints que sean seguros para el acceso público a través de herramientas de IA. +Los servidores MCP siguen un enfoque de “seguridad primero”, por lo que los endpoints de API no se exponen de forma predeterminada. Debes habilitar explícitamente los endpoints para ponerlos a disposición como herramientas MCP. Expón únicamente endpoints que sean seguros para el acceso público a través de herramientas de IA. La configuración de MCP para el endpoint. - Indica si se debe exponer el endpoint como herramienta MCP. Tiene prioridad sobre la configuración a nivel de archivo. + Indica si se debe exponer el endpoint como una herramienta MCP. Tiene prioridad sobre la configuración a nivel de archivo. @@ -63,7 +63,7 @@ Los servidores MCP siguen un enfoque de seguridad primero en el que los endpoint ### Configuración a nivel de archivo -Habilita MCP para todos los endpoints de forma predeterminada en un archivo de especificación de OpenAPI y excluye selectivamente algunos endpoints: +Habilita MCP para todos los endpoints de forma predeterminada en un archivo de especificación OpenAPI y excluye determinados endpoints de forma selectiva: ```json { @@ -79,7 +79,7 @@ Habilita MCP para todos los endpoints de forma predeterminada en un archivo de e "get": { "x-mint": { "mcp": { - "enabled": false // Desactiva MCP en este endpoint + "enabled": false // Deshabilita MCP para este endpoint } }, // ... @@ -112,7 +112,7 @@ Habilita MCP para endpoints específicos: }, "/api/v1/delete": { "delete": { - // No tiene `x-mint: mcp`, por lo que este endpoint no se expone como una herramienta de MCP + // No hay `x-mint: mcp`, así que este endpoint no se expone como una herramienta de MCP // ... } } @@ -130,11 +130,11 @@ Tus usuarios deben conectar tu servidor MCP a sus herramientas de IA preferidas. 2. Los usuarios copian la URL de tu servidor MCP y la añaden a sus herramientas. 3. Los usuarios acceden a tu documentación y a los endpoints de tu API desde sus herramientas. -Estas son algunas maneras en las que puedes ayudar a tus usuarios a conectarse a tu servidor MCP: +Estas son algunas formas en que puedes ayudar a tus usuarios a conectarse a tu servidor MCP: - Añade opciones en el [menú contextual](/es/ai/contextual-menu) para que tus usuarios se conecten a tu servidor MCP desde cualquier página de tu documentación. + Agrega opciones en el [menú contextual](/es/ai/contextual-menu) para que tus usuarios se conecten a tu servidor MCP desde cualquier página de tu documentación. | Opción | Identificador | Descripción | | :----- | :------------ | :---------- | @@ -146,17 +146,17 @@ Estas son algunas maneras en las que puedes ayudar a tus usuarios a conectarse a - Ve a tu [panel](https://dashboard.mintlify.com/products/mcp) y localiza la URL de tu servidor MCP. + Ve a tu [panel](https://dashboard.mintlify.com/products/mcp) y busca la URL de tu servidor MCP. Crea una guía para tus usuarios que incluya la URL de tu servidor MCP y los pasos para conectarlo a Claude. - 1. Ve a la página [Connectors](https://claude.ai/settings/connectors) en la configuración de Claude. + 1. Ve a la página de [Connectors](https://claude.ai/settings/connectors) en la configuración de Claude. 2. Selecciona **Add custom connector**. - 3. Añade el nombre y la URL de tu servidor MCP. + 3. Agrega el nombre y la URL de tu servidor MCP. 4. Selecciona **Add**. - 5. Al usar Claude, selecciona el botón de adjuntos (el ícono de “+”). + 5. Al usar Claude, selecciona el botón de adjuntos (el ícono de “más”). 6. Selecciona tu servidor MCP. @@ -167,7 +167,7 @@ Estas son algunas maneras en las que puedes ayudar a tus usuarios a conectarse a - Ve a tu [panel](https://dashboard.mintlify.com/products/mcp) y localiza la URL de tu servidor MCP. + Ve a tu [panel](https://dashboard.mintlify.com/products/mcp) y busca la URL de tu servidor MCP. @@ -185,7 +185,7 @@ Estas son algunas maneras en las que puedes ayudar a tus usuarios a conectarse a - Ve a tu [panel](https://dashboard.mintlify.com/products/mcp) y localiza la URL de tu servidor MCP. + Ve a tu [panel](https://dashboard.mintlify.com/products/mcp) y busca la URL de tu servidor MCP. @@ -214,7 +214,7 @@ Estas son algunas maneras en las que puedes ayudar a tus usuarios a conectarse a - Ve a tu [panel](https://dashboard.mintlify.com/products/mcp) y localiza la URL de tu servidor MCP. + Ve a tu [panel](https://dashboard.mintlify.com/products/mcp) y busca la URL de tu servidor MCP. @@ -241,14 +241,14 @@ Estas son algunas maneras en las que puedes ayudar a tus usuarios a conectarse a
- ### Ejemplo: Conectarse al servidor MCP de Mintlify + ### Ejemplo: Conexión al servidor MCP de Mintlify
-Conéctate al servidor MCP de Mintlify para interactuar con la API de Mintlify y buscar en nuestra documentación. Esto te dará respuestas más precisas sobre cómo usar Mintlify en tu entorno local y muestra cómo puedes ayudar a tus usuarios a conectarse a tu servidor MCP. +Conéctate al servidor MCP de Mintlify para interactuar con la API de Mintlify y buscar en nuestra documentación. Esto te dará respuestas más precisas sobre cómo usar Mintlify en tu entorno local y mostrará cómo puedes ayudar a tus usuarios a conectarse a tu servidor MCP. - En la parte superior de esta página, abre el menú contextual y elige **Connect to Cursor** o **Connect to VS Code** para conectar el servidor MCP de Mintlify al IDE de tu preferencia. + En la parte superior de esta página, selecciona el menú contextual y elige **Connect to Cursor** o **Connect to VS Code** para conectar el servidor MCP de Mintlify con el IDE de tu preferencia. @@ -256,7 +256,7 @@ Conéctate al servidor MCP de Mintlify para interactuar con la API de Mintlify y - 1. Ve a la página de [Connectors](https://claude.ai/settings/connectors) en la configuración de Claude. + 1. Ve a la página [Connectors](https://claude.ai/settings/connectors) en la configuración de Claude. 2. Selecciona **Add custom connector**. 3. Agrega el servidor MCP de Mintlify: @@ -267,7 +267,7 @@ Conéctate al servidor MCP de Mintlify para interactuar con la API de Mintlify y - 1. Al usar Claude, selecciona el botón de adjuntos (el ícono de más). + 1. Al usar Claude, selecciona el botón de adjuntos (el ícono de suma). 2. Selecciona el servidor MCP de Mintlify. 3. Hazle a Claude una pregunta sobre Mintlify. @@ -329,7 +329,7 @@ Conéctate al servidor MCP de Mintlify para interactuar con la API de Mintlify y Install in VS Code - Para conectar el servidor MCP de Mintlify a VS Code, haz clic en el botón **Install in VS Code**. O, para conectarlo manualmente, crea un archivo `.vscode/mcp.json` y agrega: + Para conectar el servidor MCP de Mintlify a VS Code, haz clic en el botón **Install in VS Code**. O, para conectar el servidor MCP manualmente, crea un archivo `.vscode/mcp.json` y agrega: ```json { @@ -350,20 +350,20 @@ Conéctate al servidor MCP de Mintlify para interactuar con la API de Mintlify y ## Autenticación -Cuando habilitas un endpoint de API para MCP, el servidor incluye los requisitos de autenticación definidos en los `securitySchemes` y `securityRequirement` de tu especificación OpenAPI. Cualquier clave la gestiona directamente la herramienta y no la almacena ni la procesa Mintlify. +Cuando habilitas un endpoint de API para MCP, el servidor incluye los requisitos de autenticación definidos en tus `securitySchemes` y `securityRequirement` de OpenAPI. Cualquier clave la gestiona directamente la herramienta y no es almacenada ni procesada por Mintlify. Si un usuario le pide a su herramienta de IA que invoque un endpoint protegido, la herramienta solicitará en ese momento al usuario las credenciales de autenticación necesarias.
- ## Supervisión de tu servidor MCP + ## Monitorear tu servidor MCP
-Puedes ver todas las herramientas de MCP disponibles en la sección **Available tools** de la [página MCP Server](https://dashboard.mintlify.com/products/mcp) de tu panel. +Puedes ver todas las herramientas de MCP disponibles en la sección **Available tools** de la [página MCP Server](https://dashboard.mintlify.com/products/mcp) en tu panel. - Panel de MCP con la sección Available tools resaltada + Panel de MCP con la sección Available tools destacada - +
@@ -376,9 +376,9 @@ Puedes ver todas las herramientas de MCP disponibles en la sección **Available 1. Verifica que tu especificación de OpenAPI sea válida y accesible. 2. Asegúrate de haber habilitado explícitamente MCP para endpoints específicos usando `x-mint.mcp.enabled: true`. - 3. Revisa los registros de tu implementación para detectar errores en el procesamiento de OpenAPI. + 3. Revisa los registros de tu despliegue para detectar errores en el procesamiento de OpenAPI. - Si el procesamiento de OpenAPI falla, el servidor continúa solo con la herramienta de búsqueda para mantener la funcionalidad. + Si el procesamiento de OpenAPI falla, el servidor continúa únicamente con la herramienta de búsqueda para mantener la funcionalidad. @@ -389,10 +389,10 @@ Puedes ver todas las herramientas de MCP disponibles en la sección **Available - Si las herramientas de IA no están usando tus endpoints de API de forma eficaz: + Si las herramientas de IA no están utilizando tus endpoints de API de manera efectiva: - 1. Agrega campos `summary` y `description` detallados a tus endpoints. - 2. Asegúrate de que los nombres y descripciones de parámetros sean autoexplicativos. - 3. Usa el panel de MCP para comprobar cómo se muestran tus endpoints como herramientas. + 1. Agrega campos detallados `summary` y `description` a tus endpoints. + 2. Asegúrate de que los nombres y descripciones de los parámetros sean autoexplicativos. + 3. Usa el panel de MCP para verificar cómo se muestran tus endpoints como herramientas. \ No newline at end of file diff --git a/es/ai/slack-app.mdx b/es/ai/slack-app.mdx index 5ee3d4d27..323b15dea 100644 --- a/es/ai/slack-app.mdx +++ b/es/ai/slack-app.mdx @@ -1,31 +1,30 @@ --- -title: "Slack app" -description: "Agrega un bot que busca en tu documentación para responder preguntas en tu espacio de trabajo de Slack" +title: "Aplicación de Slack" +description: "Añade un bot que busca en tu documentación para responder preguntas en tu espacio de trabajo de Slack" icon: "slack" --- - La aplicación de Slack está disponible para los [planes Pro y Enterprise](https://mintlify.com/pricing?ref=slack-app). + La aplicación de Slack está disponible para los [planes Pro y Custom](https://mintlify.com/pricing?ref=slack-app). -La aplicación de Slack agrega un bot llamado `@mintlify` a tu espacio de trabajo de Slack que puede buscar en tu documentación y responder las preguntas de los usuarios. El bot responde a mensajes directos, menciones con @ y a cualquier pregunta en un canal llamado específicamente `#ask-ai`. +La aplicación de Slack añade un bot llamado `@mintlify` a tu espacio de trabajo que puede buscar en tu documentación y responder las preguntas de los usuarios. El bot responde a mensajes directos, menciones con @ y a cualquier pregunta en un canal específicamente llamado `#ask-ai`. La aplicación de Slack puede generar costos: ya sea usando tus créditos del Asistente de IA o incurriendo en cargos por excedente. - -
- ## Configurar la aplicación de Slack + ## Configurar la app de Slack
- Si el propietario del espacio de trabajo de Slack requiere aprobación de administración para instalar aplicaciones, pídele que apruebe la aplicación de Slack de Mintlify antes de añadirla. + Si el propietario de tu espacio de trabajo de Slack requiere aprobación de administrador para instalar aplicaciones, pídele que apruebe la app de Slack de Mintlify antes de que la agregues. -1. Ve a la página de [Complementos](https://dashboard.mintlify.com/products/addons) de tu panel. -2. Selecciona **Conectar** en la tarjeta de Integración de Slack. -3. Sigue las indicaciones de Slack para añadir la aplicación a tu espacio de trabajo. -4. Verifica que el bot funciona y responde cuando: - - Envías un mensaje directo a la aplicación de Mintlify. - - Mencionas al bot con `@mintlify` en un canal. - - Creas un canal `#ask-ai`, añades el bot y haces una pregunta. +1. Ve a la página de [Add-ons](https://dashboard.mintlify.com/products/addons) de tu panel. +2. Selecciona **Connect** en la tarjeta de Slack Integration. +3. Sigue las indicaciones de Slack para añadir la app a tu espacio de trabajo. +4. Comprueba que el bot funciona y responde cuando: + +- Envías un mensaje directo a la app de Mintlify. + - Menciones al bot con `@mintlify` en un canal. + - Crees un canal `#ask-ai`, añadas el bot y hagas una pregunta. \ No newline at end of file diff --git a/es/analytics/feedback.mdx b/es/analytics/feedback.mdx index 6073f87f4..4d8db1fec 100644 --- a/es/analytics/feedback.mdx +++ b/es/analytics/feedback.mdx @@ -4,10 +4,10 @@ description: "Supervisa la satisfacción de los usuarios con tu documentación" --- - Para recopilar y ver comentarios, primero debes habilitar la función de comentarios en la página de [Complementos](https://dashboard.mintlify.com/products/addons) de tu panel. + Para recopilar y ver comentarios, primero debes habilitar la función de comentarios desde la página de [Add-ons](https://dashboard.mintlify.com/products/addons) en tu panel. -La pestaña de comentarios muestra los votos cuantitativos de “pulgar arriba” y “pulgar abajo” que han recibido tus docs, así como cualquier comentario cualitativo que hayan proporcionado los usuarios. Usa esta información para evaluar la calidad de tus docs y realizar mejoras. +La pestaña de comentarios muestra los votos cuantitativos de pulgar arriba y pulgar abajo que han recibido tus docs y cualquier comentario cualitativo que hayan proporcionado los usuarios. Usa esta información para evaluar la calidad de tus docs y realizar mejoras. Accede a la pestaña de comentarios desde la página de **Analytics** en tu [panel](https://dashboard.mintlify.com/products/analytics). @@ -16,7 +16,7 @@ Accede a la pestaña de comentarios desde la página de **Analytics** en tu [pan
- Los comentarios contextuales y sobre fragmentos de código están en beta. Para habilitarlos en tu sitio de documentación, [contacta a nuestro equipo de ventas](mailto:gtm@mintlify.com). + Los comentarios contextuales y en fragmentos de código están en beta. Para habilitarlos en tu sitio de documentación, [contacta a nuestro equipo de ventas](mailto:gtm@mintlify.com). La pestaña de comentarios muestra información según los complementos de comentarios que habilites. @@ -28,55 +28,55 @@ Habilita tus tipos de comentarios preferidos: Captura de pantalla de los toggles de comentarios en la página Add-ons. Captura de pantalla de los toggles de comentarios en la página Add-ons. * **Solo valoración con pulgares**: Votación simple de pulgar arriba/abajo para medir la satisfacción general con las páginas. -* **Solo comentarios sobre fragmentos de código**: Comentarios específicamente sobre los fragmentos de código. -* **Valoración con pulgares y comentarios contextuales**: Votación de la página más comentarios detallados y motivos de las valoraciones. -* **Valoración con pulgares y comentarios sobre fragmentos de código**: Votación de la página más comentarios sobre los ejemplos de código. -* **Valoración con pulgares, comentarios contextuales y comentarios sobre fragmentos de código**: Sistema de comentarios completo con votación de la página, comentarios detallados y comentarios sobre fragmentos de código. +* **Solo comentarios sobre fragmentos de código**: Comentarios específicamente sobre fragmentos de código. +* **Valoración con pulgares y comentarios contextuales**: Votación de página más comentarios detallados y motivos de las valoraciones. +* **Valoración con pulgares y comentarios sobre fragmentos de código**: Votación de página más comentarios sobre ejemplos de código. +* **Valoración con pulgares, comentarios contextuales y comentarios sobre fragmentos de código**: Sistema de comentarios completo con votación de página, comentarios detallados y comentarios sobre fragmentos de código.
## Gestión de comentarios
-Para los comentarios contextuales y sobre fragmentos de código, puedes establecer el estado de cada comentario y añadir notas internas para hacer seguimiento de tu trabajo al resolver el feedback de los usuarios. +Para comentarios contextuales y sobre fragmentos de código, puedes establecer el estado de un comentario y añadir notas internas para hacer seguimiento de tu trabajo al resolver el feedback de los usuarios.
- ### Cambiar el estado del feedback + ### Cambiar el estado de los comentarios
-Selecciona el estado junto a un feedback para marcarlo como **Pendiente**, **En progreso**, **Resuelto** o **Descartado**. +Selecciona el estado junto a un comentario para marcarlo como **Pendiente**, **En progreso**, **Resuelto** o **Descartado**. -Mejores prácticas para establecer estados de feedback: +Mejores prácticas para definir estados de comentarios: -* **Pendiente**: El feedback está en espera de revisión. -* **En progreso**: El feedback ha sido validado y se está trabajando en él. -* **Resuelto**: El feedback ha sido resuelto. -* **Descartado**: El feedback se ha descartado por no ser accionable, por irrelevante o por inexacto. +* **Pendiente**: El comentario está a la espera de revisión. +* **En progreso**: El comentario ha sido validado y se está trabajando en él. +* **Resuelto**: El comentario se ha resuelto. +* **Descartado**: El comentario se descarta por no ser accionable, por irrelevante o por inexacto.
### Filtrar por estado
-Usa el filtro de estado para controlar qué comentarios se muestran. Desmarca un estado para ocultar todos los comentarios con ese estado. De forma predeterminada, se muestran todos los comentarios. +Utiliza el filtro de estado para controlar qué comentarios se muestran. Desmarca un estado para ocultar todos los comentarios con ese estado. De forma predeterminada, se muestran todos los comentarios.
### Agregar notas internas
-Haz clic en un comentario para añadir una nota interna. Estas notas solo son visibles para quienes tengan acceso a tu panel. +Haz clic en un comentario para agregar una nota interna. Estas notas solo son visibles para quienes tienen acceso a tu panel. -Usa las notas para añadir información para colaborar, vincular tickets relevantes de soporte o de ingeniería, o recordar cualquier otra información útil. +Usa las notas para añadir información para la colaboración, enlazar tickets relevantes de soporte o de ingeniería, o recordar cualquier otra información útil.
## Uso de los datos de comentarios @@ -86,4 +86,4 @@ Revisa tus datos de comentarios para: * **Identificar contenido eficaz**: Las páginas con más comentarios positivos muestran qué funciona bien en tu documentación. * **Priorizar mejoras**: Las páginas con más comentarios negativos indican qué contenido podría requerir atención. - * **Tomar medidas**: Realiza actualizaciones en la documentación basadas en comentarios directos de los usuarios. \ No newline at end of file + * **Tomar acción**: Realiza actualizaciones en la documentación basadas en comentarios directos de los usuarios. \ No newline at end of file diff --git a/es/analytics/improving-docs.mdx b/es/analytics/improving-docs.mdx index 3d65155b6..2ae2ee8ba 100644 --- a/es/analytics/improving-docs.mdx +++ b/es/analytics/improving-docs.mdx @@ -1,40 +1,40 @@ --- title: "Mejora tu documentación" -description: "Usa datos de analítica para mejorar tu documentación" +description: "Usa los datos de analítica para mejorar tu documentación" --- Mejora tu documentación con datos cuantitativos y cualitativos de tu panel de analítica.
- ## Información de analítica cruzada + ## Información de analíticas cruzadas
-Combina datos de varias fuentes de analítica para obtener una visión integral de tu documentación. +Combina datos de múltiples fuentes de analítica para obtener una visión integral de tu documentación.
- ### Correlaciona tráfico y satisfacción + ### Correlaciona el tráfico y la satisfacción
- **Alto tráfico y bajas calificaciones**: Páginas populares con una mala experiencia de usuario. Prioriza mejorar estas páginas. -- **Bajo tráfico y altas calificaciones**: Documentación que funciona bien, pero quizá no sea fácil de descubrir. Considera promocionar estas páginas. -- **Alto tráfico y altas calificaciones**: Los éxitos de tu documentación. Revisa estas páginas para obtener ideas que mejoren el resto de tu contenido. +- **Bajo tráfico y altas calificaciones**: Documentación que funciona bien, pero puede que no sea fácil de encontrar. Considera promocionar estas páginas. +- **Alto tráfico y altas calificaciones**: Los grandes éxitos de tu documentación. Revisa estas páginas para inspirarte y mejorar el resto de tu contenido.
### Alinea la intención de búsqueda con el rendimiento del contenido
-- **Alto volumen de búsqueda y pocas vistas de página**: Problemas de descubrimiento. Considera mover estas páginas o revisar su frontmatter. -- **Términos de búsqueda populares y resultados con baja confianza**: Oportunidad por brecha de contenido. Considera agregar más contenido o crear contenido nuevo sobre estos temas. -- **Búsquedas principales y comentarios negativos en las páginas correspondientes**: Problemas de experiencia de usuario. Revisa las páginas para ver si resuelven la necesidad del usuario que motiva la búsqueda. +- **Alto volumen de búsqueda y pocas vistas de página**: Problemas de descubrimiento. Considera reubicar estas páginas o revisar su frontmatter. +- **Términos de búsqueda populares y resultados con baja confianza**: Oportunidad por brecha de contenido. Considera añadir más contenido o crear contenido nuevo sobre estos temas. +- **Búsquedas principales y comentarios negativos en las páginas correspondientes**: Problemas de experiencia de usuario. Revisa las páginas para verificar si realmente resuelven la necesidad del usuario que motivó la búsqueda.
- ## Convierte los insights en acción + ## Ponga los insights en acción
-Utiliza estos patrones de analítica cruzada para priorizar las mejoras de tu documentación: +Use estos patrones de analítica cruzada para priorizar las mejoras de su documentación: -- **Resuelve primero los problemas de alto impacto**: Las páginas populares con bajas valoraciones afectan a más usuarios. -- **Cubre las brechas de contenido verificadas**: Las búsquedas de alto volumen y baja confianza indican necesidades de usuario no satisfechas. -- **Responde al feedback de los usuarios**: El feedback contextual y sobre fragmentos de código puede señalar áreas específicas de mejora. -- **Alinea la búsqueda con el contenido**: Asegúrate de que tus temas más buscados tengan páginas completas y bien organizadas. -- **Supervisa las tendencias de búsqueda en ascenso sin páginas populares existentes**: Oportunidades para nuevo contenido. \ No newline at end of file +- **Solucione primero los problemas de alto impacto**: Las páginas populares con malas valoraciones afectan a más usuarios. +- **Cubra las brechas de contenido verificadas**: Las búsquedas con baja confianza y alto volumen indican necesidades no cubiertas. +- **Responda a los comentarios de los usuarios**: Los comentarios contextuales y sobre fragmentos de código pueden señalar áreas específicas de mejora. +- **Alinee la búsqueda con el contenido**: Asegúrese de que sus temas más buscados tengan páginas completas y bien organizadas. +- **Monitoree las tendencias de búsqueda al alza sin páginas populares existentes**: Nuevas oportunidades de contenido. \ No newline at end of file diff --git a/es/analytics/overview.mdx b/es/analytics/overview.mdx index 82cd537b2..785d4bcff 100644 --- a/es/analytics/overview.mdx +++ b/es/analytics/overview.mdx @@ -1,9 +1,9 @@ --- title: "Descripción general" -description: "Consulta el tráfico y las estadísticas de alto nivel sobre tu documentación" +description: "Consulta el tráfico y los insights de alto nivel sobre tu documentación" --- -La pestaña de descripción general muestra cuántas personas han visitado tu documentación, cuáles son las páginas más populares y de dónde provienen los usuarios. Usa esta información para identificar qué páginas aportan más valor a tus usuarios y seguir las tendencias a lo largo del tiempo. +La pestaña de descripción general muestra cuántas personas han visitado tu documentación, qué páginas son más populares y de dónde provienen los usuarios. Usa esta información para identificar cuáles son las páginas más valiosas para tus usuarios y hacer un seguimiento de las tendencias a lo largo del tiempo. Accede a las métricas de la descripción general desde la página de **Analytics** en tu [panel](https://dashboard.mintlify.com/products/analytics). @@ -11,19 +11,19 @@ Accede a las métricas de la descripción general desde la página de **Analytic ## Métricas
-Usa el selector de rango para ajustar el período de tiempo de los datos mostrados. Selecciona visitantes, vistas o acciones para mostrar un gráfico de líneas con las tendencias durante el período seleccionado. +Usa el selector de rango para ajustar el periodo de los datos mostrados. Selecciona visitantes, vistas o acciones para mostrar un gráfico de líneas con las tendencias durante el periodo seleccionado. -- **Visitantes**: Visitantes únicos -- **Vistas**: Total de vistas de página -- **Acciones**: Conteo combinado de llamadas a la API, clics en enlaces de la barra de navegación y clics en botones de CTA -- **Páginas populares**: Rutas a las páginas más visitadas y sus conteos de vistas -- **Referencias**: Principales fuentes de tráfico que dirigen usuarios a tu documentación +- **Visitors**: Visitantes únicos +- **Views**: Total de vistas de página +- **Actions**: Recuento combinado de llamadas a la API, clics en enlaces de la barra de navegación y clics en botones de CTA +- **Popular Pages**: Rutas a las páginas más visitadas y su número de vistas +- **Referrers**: Principales fuentes de tráfico que dirigen usuarios a tu documentación
- ## Uso de los datos de la vista general + ## Uso de los datos generales
-Revisa tus métricas de la vista general para: +Revisa tus métricas generales para: -- **Identificar páginas populares**: Usa las páginas populares para comprender qué contenido es más importante para tus usuarios y asegurarte de que esté actualizado y sea completo. -- **Hacer seguimiento a las tendencias de tráfico**: Supervisa los cambios en el tráfico para entender el impacto de las actualizaciones o del contenido nuevo. \ No newline at end of file +- **Identificar páginas populares**: Usa las páginas más vistas para entender qué contenido es más importante para tus usuarios y asegurarte de que esté actualizado y sea completo. +- **Seguir tendencias de tráfico**: Monitorea los cambios en el tráfico para entender el impacto de las actualizaciones o del contenido nuevo. \ No newline at end of file diff --git a/es/analytics/search.mdx b/es/analytics/search.mdx index 5a63efaa0..3ca10d990 100644 --- a/es/analytics/search.mdx +++ b/es/analytics/search.mdx @@ -1,9 +1,9 @@ --- title: "Búsqueda" -description: "Entiende cómo los usuarios buscan en tu documentación" +description: "Entiende cómo buscan los usuarios en tu documentación" --- -Utiliza los datos de la pestaña de Búsqueda para entender qué buscan los usuarios e identificar temas que deban actualizarse o ampliarse. +Usa los datos de la pestaña de búsqueda para entender qué buscan los usuarios e identificar temas que deban actualizarse o ampliarse. Accede a tus métricas de búsqueda desde la página de **Analytics** en tu [panel](https://dashboard.mintlify.com/products/analytics). @@ -11,11 +11,11 @@ Accede a tus métricas de búsqueda desde la página de **Analytics** en tu [pan ## Métricas de búsqueda -Utiliza el selector de rango para ajustar el período de tiempo de los datos mostrados. +Usa el selector de rango para ajustar el periodo de tiempo de los datos mostrados. - **Consultas totales**: Volumen de búsqueda - **Búsquedas principales**: Términos más buscados -- **Búsquedas con baja confianza**: Consultas que pueden no haber arrojado resultados relevantes +- **Búsquedas con baja confianza**: Consultas que podrían no haber devuelto resultados relevantes
## Uso de los datos de búsqueda @@ -23,6 +23,6 @@ Utiliza el selector de rango para ajustar el período de tiempo de los datos mos Revisa tus analíticas de búsqueda para: -- **Identificar temas populares**: Usa las búsquedas principales para entender qué contenido buscan las personas. -- **Detectar vacíos de contenido**: Las búsquedas con baja confianza pueden indicar documentación faltante o temas que requieren mejor cobertura. -- **Mejorar la descubribilidad**: Asegúrate de que las páginas que coincidan con los términos de búsqueda populares sean fáciles de encontrar y estén bien organizadas. \ No newline at end of file +- **Identificar temas populares**: Usa las búsquedas principales para entender qué contenido busca la gente. +- **Detectar brechas de contenido**: Las búsquedas con baja confianza pueden indicar documentación faltante o temas que requieren mejor cobertura. +- **Mejorar la capacidad de descubrimiento**: Asegúrate de que las páginas que coinciden con términos de búsqueda populares sean fáciles de encontrar y estén bien organizadas. \ No newline at end of file diff --git a/es/api-playground/asyncapi/setup.mdx b/es/api-playground/asyncapi/setup.mdx index 6eab4379a..31166c43b 100644 --- a/es/api-playground/asyncapi/setup.mdx +++ b/es/api-playground/asyncapi/setup.mdx @@ -1,15 +1,15 @@ --- title: "Configuración de AsyncAPI" -description: "Crea páginas de referencia de WebSocket con AsyncAPI" +description: "Crea páginas de referencia de websocket con AsyncAPI" ---
- ## Añadir un archivo de especificación de AsyncAPI + ## Agrega un archivo de especificación de AsyncAPI
-Para empezar a crear páginas para tus websockets, asegúrate de contar con un documento de esquema de AsyncAPI válido en formato JSON o YAML que cumpla con la [especificación de AsyncAPI](https://www.asyncapi.com/docs/reference/specification/v3.0.0). Tu esquema debe ajustarse a la especificación de AsyncAPI 3.0+. +Para empezar a crear páginas para tus websockets, asegúrate de contar con un documento de esquema de AsyncAPI válido en formato JSON o YAML que cumpla con la [especificación de AsyncAPI](https://www.asyncapi.com/docs/reference/specification/v3.0.0). Tu esquema debe ajustarse a la especificación 3.0+ de AsyncAPI. Para comprobar que tu esquema de AsyncAPI sea válido, puedes pegarlo en @@ -22,35 +22,33 @@ Para empezar a crear páginas para tus websockets, asegúrate de contar con un d ## Autogenerar páginas de websockets
-Puedes agregar un campo `asyncapi` a cualquier pestaña o grupo en la navegación de tu `docs.json`. Este campo puede contener la ruta a un documento de esquema de AsyncAPI en tu repositorio de documentación, la URL de un documento de esquema de AsyncAPI alojado o un arreglo de enlaces a documentos de esquema de AsyncAPI. Mintlify generará automáticamente una página para cada canal de websocket de AsyncAPI. +Puedes agregar un campo `asyncapi` a cualquier pestaña o grupo en la navegación de tu `docs.json`. Este campo puede contener la ruta a un documento de esquema de AsyncAPI en tu repositorio de documentación, la URL de un documento de esquema de AsyncAPI alojado o una matriz de enlaces a documentos de esquema de AsyncAPI. Mintlify generará automáticamente una página para cada canal de websocket de AsyncAPI. **Ejemplos con pestañas:** - -```json Local File {5} -"navigation": { - "tabs": [ - { - "tab": "API Reference", - "asyncapi": "/path/to/asyncapi.json" - } - ] -} - -``` - -```json Remote URL {5} -"navigation": { - "tabs": [ - { - "tab": "API Reference", - "asyncapi": "https://github.com/asyncapi/spec/blob/master/examples/simple-asyncapi.yml" - } - ] -} -``` - + ```json Local File {5} + "navigation": { + "tabs": [ + { + "tab": "API Reference", + "asyncapi": "/path/to/asyncapi.json" + } + ] + } + + ``` + + ```json Remote URL {5} + "navigation": { + "tabs": [ + { + "tab": "API Reference", + "asyncapi": "https://github.com/asyncapi/spec/blob/master/examples/simple-asyncapi.yml" + } + ] + } + ``` **Ejemplos con grupos:** @@ -62,10 +60,10 @@ Puedes agregar un campo `asyncapi` a cualquier pestaña o grupo en la navegació "tab": "AsyncAPI", "groups": [ { - "group": "Websockets", + "group": "WebSockets", "asyncapi": { "source": "/path/to/asyncapi.json", - "directory": "api-reference" + "directory": "referencia-api" } } ] @@ -75,17 +73,16 @@ Puedes agregar un campo `asyncapi` a cualquier pestaña o grupo en la navegació ``` - El campo directory es opcional. Si no se especifica, los archivos se colocarán en - la carpeta **api-reference** del repositorio de documentación. + El campo directory es opcional. Si no se especifica, los archivos se ubicarán en + la carpeta **api-reference** del repositorio de docs. -
## Página de canal
-Si quieres tener más control sobre el orden de tus canales o simplemente hacer referencia a un canal específico, puedes crear un archivo MDX con el campo `asyncapi` en el frontmatter. +Si quieres tener más control sobre el orden de tus canales o simplemente referenciar un canal específico, puedes crear un archivo MDX con el campo `asyncapi` en el frontmatter. ```mdx --- diff --git a/es/api-playground/customization/adding-sdk-examples.mdx b/es/api-playground/customization/adding-sdk-examples.mdx index c82b97333..fc14a265f 100644 --- a/es/api-playground/customization/adding-sdk-examples.mdx +++ b/es/api-playground/customization/adding-sdk-examples.mdx @@ -1,25 +1,25 @@ --- title: "Agregar ejemplos de SDK" -description: "Muestra fragmentos de código por lenguaje junto a tus endpoints de API para mostrar a los desarrolladores cómo usar tus SDK" +description: "Muestra ejemplos de código específicos por lenguaje junto a tus endpoints de API para enseñar a los desarrolladores cómo usar tus SDK" --- -Si tus usuarios interactúan con tu API mediante un SDK en lugar de hacerlo directamente a través de una solicitud de red, puedes usar la extensión `x-codeSamples` para agregar fragmentos de código a tu documento de OpenAPI y mostrarlos en tus páginas de OpenAPI. +Si tus usuarios interactúan con tu API mediante un SDK en lugar de hacerlo directamente con una solicitud de red, puedes usar la extensión `x-codeSamples` para agregar ejemplos de código a tu documento de OpenAPI y mostrarlos en tus páginas de OpenAPI. Esta propiedad se puede agregar a cualquier método de solicitud y tiene el siguiente esquema. - El lenguaje del fragmento de código. + El lenguaje del ejemplo de código. - La etiqueta del ejemplo. Es útil cuando se proporcionan varios ejemplos para un único endpoint. + La etiqueta del ejemplo. Es útil cuando proporcionas múltiples ejemplos para un solo endpoint. El código fuente del ejemplo. -Aquí tienes un ejemplo de fragmentos de código para una app de seguimiento de plantas, que cuenta tanto con una herramienta de línea de comandos en Bash como con un SDK de JavaScript. +A continuación se muestra un ejemplo de ejemplos de código para una app de seguimiento de plantas, que cuenta con una herramienta de CLI en Bash y un SDK de JavaScript. ```yaml paths: @@ -28,22 +28,21 @@ paths: # ... x-codeSamples: - lang: bash - label: List all unwatered plants + label: Listar todas las plantas sin regar source: | planter list -u - lang: javascript - label: List all unwatered plants + label: Listar todas las plantas sin regar source: | const planter = require('planter'); planter.list({ unwatered: true }); - lang: bash - label: List all potted plants + label: Listar todas las plantas en maceta source: | planter list -p - lang: javascript - label: List all potted plants + label: Listar todas las plantas en maceta source: | const planter = require('planter'); planter.list({ potted: true }); ``` - diff --git a/es/api-playground/customization/complex-data-types.mdx b/es/api-playground/customization/complex-data-types.mdx index 03a9e5e23..3ab7ba263 100644 --- a/es/api-playground/customization/complex-data-types.mdx +++ b/es/api-playground/customization/complex-data-types.mdx @@ -1,9 +1,9 @@ --- title: "Tipos de datos complejos" -description: "Describe APIs con esquemas flexibles, propiedades opcionales y múltiples formatos de datos usando las palabras clave `oneOf`, `anyOf` y `allOf`" +description: "Describe APIs con esquemas flexibles, propiedades opcionales y múltiples formatos de datos mediante las palabras clave `oneOf`, `anyOf` y `allOf`" --- -Cuando tu API admite múltiples formatos de datos, tiene campos condicionales o utiliza patrones de herencia, las palabras clave de composición de esquemas de OpenAPI te ayudan a documentar estas estructuras flexibles. Con `oneOf`, `anyOf` y `allOf`, puedes describir APIs que manejan distintos tipos de entrada o combinan múltiples esquemas en modelos de datos completos. +Cuando tu API acepta varios formatos de datos, tiene campos condicionales o utiliza patrones de herencia, las palabras clave de composición de esquemas de OpenAPI te ayudan a documentar estas estructuras flexibles. Con `oneOf`, `anyOf` y `allOf`, puedes describir APIs que admiten diferentes tipos de entrada o combinan múltiples esquemas en modelos de datos completos. @@ -13,21 +13,21 @@ Cuando tu API admite múltiples formatos de datos, tiene campos condicionales o Para tipos de datos complejos, OpenAPI proporciona palabras clave para combinar esquemas: -- `allOf`: Combina varios esquemas (como fusionar objetos o extender un esquema base). Funciona como un operador lógico `and`. -- `anyOf`: Acepta datos que coincidan con cualquiera de los esquemas proporcionados. Funciona como un operador lógico `or`. -- `oneOf`: Acepta datos que coincidan exactamente con uno de los esquemas proporcionados. Funciona como un operador lógico `xor` (o exclusivo). +* `allOf`: Combina varios esquemas (como fusionar objetos o extender un esquema base). Funciona como un operador lógico `and`. +* `anyOf`: Acepta datos que coincidan con cualquiera de los esquemas proporcionados. Funciona como un operador lógico `or`. +* `oneOf`: Acepta datos que coincidan con exactamente uno de los esquemas proporcionados. Funciona como un operador `xor` (o “exclusive-or”). -Mintlify trata `oneOf` y `anyOf` de forma idéntica, ya que la diferencia práctica rara vez afecta el uso de la API. +Mintlify trata `oneOf` y `anyOf` de manera idéntica, ya que la diferencia práctica rara vez afecta el uso de la API. -Para especificaciones detalladas de estas palabras clave, consulta la [documentación de OpenAPI](https://swagger.io/docs/specification/data-models/oneof-anyof-allof-not/). +Para leer las especificaciones detalladas de estas palabras clave, consulta la [documentación de OpenAPI](https://swagger.io/docs/specification/data-models/oneof-anyof-allof-not/). -La palabra clave `not` no es compatible por el momento. +La palabra clave `not` actualmente no es compatible.
### Combinación de esquemas con `allOf`
-Cuando usas `allOf`, Mintlify realiza un preprocesamiento en tu documento de OpenAPI para mostrar combinaciones complejas de forma legible. Por ejemplo, cuando combinas dos esquemas de objeto con `allOf`, Mintlify fusiona las propiedades de ambos en un único objeto. Esto resulta especialmente útil al aprovechar los [componentes](https://swagger.io/docs/specification/components/) reutilizables de OpenAPI. +Cuando usas `allOf`, Mintlify realiza cierto preprocesamiento en tu documento de OpenAPI para mostrar combinaciones complejas de forma legible. Por ejemplo, cuando combinas dos esquemas de objeto con `allOf`, Mintlify fusiona las propiedades de ambos en un solo objeto. Esto resulta especialmente útil al aprovechar los [componentes](https://swagger.io/docs/specification/components/) reutilizables de OpenAPI. ```yaml org_with_users: @@ -37,7 +37,7 @@ org_with_users: properties: users: type: array - description: An array containing all users in the organization + description: Una lista que contiene a todos los usuarios de la organización # ... components: schemas: @@ -46,7 +46,7 @@ components: properties: id: type: string - description: The ID of the organization + description: El ID de la organización ``` @@ -54,8 +54,9 @@ components: El ID de la organización + - Un arreglo que contiene a todos los usuarios de la organización + Una matriz que contiene a todos los usuarios de la organización @@ -64,7 +65,7 @@ components: ### Proporcionar opciones con `oneOf` y `anyOf` -Cuando usas `oneOf` o `anyOf`, las opciones se muestran en un contenedor con pestañas. Especifica un campo `title` en cada subesquema para dar nombre a tus opciones. Por ejemplo, así podrías mostrar dos tipos diferentes de direcciones de entrega: +Cuando usas `oneOf` o `anyOf`, las opciones se muestran en un contenedor con pestañas. Especifica un campo `title` en cada subesquema para asignar nombre a tus opciones. Por ejemplo, así podrías mostrar dos tipos diferentes de direcciones de entrega: ```yaml delivery_address: @@ -74,14 +75,14 @@ delivery_address: properties: address_line_1: type: string - description: The street address of the recipient + description: La dirección del destinatario # ... - title: POBox type: object properties: box_number: type: string - description: The number of the PO Box + description: El número del apartado de correos # ... ``` @@ -90,9 +91,10 @@ delivery_address: - La dirección de la calle de la residencia + La dirección de la residencia + El número del apartado postal diff --git a/es/api-playground/customization/managing-page-visibility.mdx b/es/api-playground/customization/managing-page-visibility.mdx index f631e8383..115f7f96a 100644 --- a/es/api-playground/customization/managing-page-visibility.mdx +++ b/es/api-playground/customization/managing-page-visibility.mdx @@ -1,9 +1,9 @@ --- -title: "Gestionar la visibilidad de páginas" +title: "Gestión de la visibilidad de páginas" description: "Controla qué endpoints de tu especificación OpenAPI aparecen en la navegación de tu documentación" --- -Puedes controlar qué operaciones de OpenAPI se publican como páginas de documentación y su visibilidad en la navegación. Esto es útil para endpoints internos, operaciones obsoletas, funciones beta o endpoints que deberían ser accesibles mediante URL directa pero no visibles en la navegación del sitio. +Puedes controlar qué operaciones de OpenAPI se publican como páginas de documentación y su visibilidad en la navegación. Esto es útil para endpoints internos, operaciones obsoletas, funciones beta o endpoints que deberían ser accesibles mediante una URL directa pero no detectables a través de la navegación del sitio. Si tus páginas se generan automáticamente a partir de un documento de OpenAPI, puedes gestionar la visibilidad de las páginas con las extensiones `x-hidden` y `x-excluded`. @@ -29,10 +29,10 @@ Los casos de uso comunes de `x-hidden` son: La extensión `x-excluded` excluye por completo un endpoint de tu documentación. -Los casos de uso habituales de `x-excluded` incluyen: +Casos de uso comunes de `x-excluded`: - Endpoints internos. -- Endpoints obsoletos que no quieres documentar. +- Endpoints en desuso que no quieres documentar. - Funcionalidades beta que aún no están listas para la documentación pública. @@ -41,7 +41,7 @@ Los casos de uso habituales de `x-excluded` incluyen: ## Implementación -Agrega la extensión `x-hidden` o `x-excluded` debajo del método HTTP en tu especificación de OpenAPI. +Añade la extensión `x-hidden` o `x-excluded` debajo del método HTTP en tu especificación de OpenAPI. A continuación se muestran ejemplos de cómo usar cada propiedad en un documento de esquema de OpenAPI para un endpoint y una ruta de webhook. @@ -57,7 +57,7 @@ A continuación se muestran ejemplos de cómo usar cada propiedad en un document "/hidden_plants": { "get": { "x-hidden": true, - "description": "Devuelve todas las plantas algo secretas de la tienda", + "description": "Devuelve todas las plantas semi secretas de la tienda", "parameters": { /*...*/ }, "responses": { /*...*/ } } @@ -65,7 +65,7 @@ A continuación se muestran ejemplos de cómo usar cada propiedad en un document "/secret_plants": { "get": { "x-excluded": true, - "description": "Devuelve todas las plantas altamente secretas de la tienda (¡no publiques este endpoint!)", + "description": "Devuelve todas las plantas de máxima confidencialidad de la tienda (¡no publiques este endpoint!)" "parameters": { /*...*/ }, "responses": { /*...*/ } } @@ -77,19 +77,19 @@ A continuación se muestran ejemplos de cómo usar cada propiedad en un document "webhooks": { "/plants_hook": { "post": { - "description": "Webhook con información sobre una nueva planta añadida a la tienda", + "description": "Webhook para obtener información sobre una nueva planta añadida a la tienda", } }, "/hidden_plants_hook": { "post": { "x-hidden": true, - "description": "Webhook con información algo secreta sobre una nueva planta añadida a la tienda" + "description": "Webhook para obtener información algo confidencial sobre una nueva planta añadida a la tienda", } }, "/secret_plants_hook": { "post": { "x-excluded": true, - "description": "Webhook con información altamente secreta sobre una nueva planta añadida a la tienda (¡no publiques este endpoint!)" + "description": "Webhook para obtener información estrictamente confidencial sobre una nueva planta añadida a la tienda (¡no publiques este endpoint!)" } } } diff --git a/es/api-playground/customization/multiple-responses.mdx b/es/api-playground/customization/multiple-responses.mdx index e0df2f62d..699b27de6 100644 --- a/es/api-playground/customization/multiple-responses.mdx +++ b/es/api-playground/customization/multiple-responses.mdx @@ -3,14 +3,14 @@ title: "Respuestas múltiples" description: "Mostrar variaciones de respuesta para el mismo endpoint" --- -Si tu API devuelve diferentes respuestas según los parámetros de entrada, el contexto del usuario u otras condiciones de la solicitud, puedes documentar varios ejemplos de respuesta con la propiedad `examples`. +Si tu API devuelve distintas respuestas según los parámetros de entrada, el contexto del usuario u otras condiciones de la solicitud, puedes documentar múltiples ejemplos de respuesta con la propiedad `examples`. -Esta propiedad se puede agregar a cualquier respuesta y tiene el siguiente esquema. +Esta propiedad se puede añadir a cualquier respuesta y tiene el siguiente esquema. ```yaml responses: "200": - description: Respuesta correcta + description: Respuesta satisfactoria content: application/json: schema: @@ -23,7 +23,7 @@ responses: currencyCode: "USD" taxRate: 0.0825 gb: - summary: Respuesta para Reino Unido + summary: Respuesta para el Reino Unido value: countryCode: "GB" currencyCode: "GBP" diff --git a/es/api-playground/mdx/authentication.mdx b/es/api-playground/mdx/authentication.mdx index ae2c85b00..f1671dbe8 100644 --- a/es/api-playground/mdx/authentication.mdx +++ b/es/api-playground/mdx/authentication.mdx @@ -1,6 +1,6 @@ --- title: "Autenticación" -description: "Puedes configurar parámetros de autenticación para permitir que los usuarios usen sus claves de API reales." +description: "Puedes configurar parámetros de autenticación para que los usuarios usen sus claves de API reales." --- @@ -9,9 +9,9 @@ description: "Puedes configurar parámetros de autenticación para permitir que ## Habilitar la autenticación -Puedes agregar un método de autenticación a tu `docs.json` para habilitarlo globalmente en todas las páginas, o configurarlo por página. +Puedes agregar un método de autenticación en tu `docs.json` para habilitarla globalmente en todas las páginas o configurarla de forma individual por página. -El método de autenticación definido en una página anulará el método global si ambos están configurados. +El método de autenticación de una página tendrá prioridad sobre el método global si ambos están configurados.
### Token Bearer @@ -93,7 +93,7 @@ authMethod: "key" ### Ninguno
-El método de autenticación "none" es útil para desactivar la autenticación en un endpoint específico después de establecer un valor predeterminado en docs.json. +El método de autenticación "none" es útil para desactivar la autenticación en un endpoint específico después de establecer un valor predeterminado en `docs.json`. ```mdx Page Metadata diff --git a/es/api-playground/mdx/configuration.mdx b/es/api-playground/mdx/configuration.mdx index 375caef75..0d3185f89 100644 --- a/es/api-playground/mdx/configuration.mdx +++ b/es/api-playground/mdx/configuration.mdx @@ -1,11 +1,11 @@ --- -title: "Configuración de MDX" -description: "Genera páginas de documentación para tus endpoints de API usando `MDX`" +title: 'Configuración de MDX' +description: 'Genera páginas de documentación para tus endpoints de API usando `MDX`' --- -Puedes definir manualmente endpoints de API en archivos `MDX` individuales en lugar de usar una especificación de OpenAPI. Este método brinda flexibilidad para contenido personalizado, pero recomendamos generar la documentación de la API a partir de un archivo de especificación de OpenAPI para la mayoría de los proyectos porque es más fácil de mantener y ofrece más funciones. Sin embargo, crear páginas `MDX` para una API puede ser útil para documentar APIs pequeñas o para crear prototipos. +Puedes definir manualmente endpoints de API en archivos `MDX` individuales en lugar de usar una especificación OpenAPI. Este método ofrece flexibilidad para contenido personalizado, pero recomendamos generar la documentación de la API a partir de un archivo de especificación OpenAPI para la mayoría de los proyectos porque es más fácil de mantener y más completo en funcionalidades. Aun así, crear páginas `MDX` para una API puede ser útil para documentar APIs pequeñas o para prototipado. -Para generar páginas para endpoints de API usando `MDX`, configura los ajustes de tu API en `docs.json`, crea archivos `MDX` individuales para cada endpoint y usa componentes como `` para definir parámetros. A partir de estas definiciones, Mintlify genera áreas de pruebas de API interactivas, ejemplos de solicitudes y ejemplos de respuestas. +Para generar páginas para endpoints de API usando `MDX`, configura tu API en `docs.json`, crea archivos `MDX` individuales para cada endpoint y usa componentes como `` para definir parámetros. A partir de estas definiciones, Mintlify genera áreas de pruebas de API interactivas, ejemplos de solicitudes y de respuestas. @@ -36,7 +36,7 @@ Para generar páginas para endpoints de API usando `MDX`, configura los ajustes Encuentra la lista completa de configuraciones de API en [Settings](/es/settings#api-configurations). - + Cada página de endpoint de API debe tener un archivo `MDX` correspondiente. En la parte superior de cada archivo, define `title` y `api`: ```mdx @@ -46,7 +46,7 @@ Para generar páginas para endpoints de API usando `MDX`, configura los ajustes --- ``` - Puedes especificar parámetros de ruta agregando el nombre del parámetro a la ruta, entre `{}`: + Puedes especificar parámetros de ruta añadiendo el nombre del parámetro a la ruta, entre llaves `{}`: ```bash https://api.example.com/v1/endpoint/{userId} @@ -72,7 +72,7 @@ Para generar páginas para endpoints de API usando `MDX`, configura los ajustes - Agrega tus páginas de endpoints a la barra lateral añadiendo las rutas al campo `navigation` en tu `docs.json`. Obtén más información sobre cómo estructurar tu documentación en [Navigation](/es/navigation). + Agrega las páginas de tus endpoints a la barra lateral añadiendo las rutas al campo `navigation` en tu `docs.json`. Obtén más información sobre cómo estructurar tu documentación en [Navigation](/es/navigation). @@ -80,9 +80,9 @@ Para generar páginas para endpoints de API usando `MDX`, configura los ajustes ## Habilitar la autenticación -Puedes añadir un método de autenticación en tu `docs.json` para habilitarlo globalmente en todas las páginas o configurarlo por página. +Puedes añadir un método de autenticación a tu `docs.json` para habilitarla globalmente en todas las páginas, o configurarlo por página. -El método de autenticación definido en una página anulará el método global si ambos están establecidos. +El método de autenticación definido en una página tendrá prioridad sobre el global si ambos están configurados.
### Token Bearer diff --git a/es/api-playground/migrating-from-mdx.mdx b/es/api-playground/migrating-from-mdx.mdx index 21cb4cf2e..37dc36475 100644 --- a/es/api-playground/migrating-from-mdx.mdx +++ b/es/api-playground/migrating-from-mdx.mdx @@ -1,13 +1,13 @@ --- -title: "Migrar páginas de API en MDX a navegación con OpenAPI" +title: "Migrar páginas de API en MDX a la navegación con OpenAPI" sidebarTitle: "Migrar desde MDX" -description: "Actualiza de páginas de endpoints individuales en MDX a generación automática con OpenAPI y navegación flexible" +description: "Actualiza de páginas individuales de endpoints en MDX a generación automatizada con OpenAPI y navegación flexible" icon: "arrow-big-right-dash" --- -Si actualmente usas páginas individuales en `MDX` para tus endpoints de API, puedes migrar a generar las páginas automáticamente desde tu especificación de OpenAPI, conservando la personalización de las páginas individuales. Esto puede ayudarte a reducir la cantidad de archivos que debes mantener y a mejorar la coherencia de tu documentación de API. +Si actualmente usas páginas individuales en `MDX` para los endpoints de tu API, puedes migrar a la generación automática de páginas desde tu especificación de OpenAPI manteniendo la capacidad de personalizar cada página. Esto puede ayudarte a reducir la cantidad de archivos que debes mantener y mejorar la consistencia de tu documentación de API. -Puedes definir metadatos y contenido para cada endpoint en tu especificación de OpenAPI y ubicar los endpoints donde desees en la navegación. +Puedes definir metadatos y contenido para cada endpoint en tu especificación de OpenAPI y organizar los endpoints donde quieras en la navegación.
## Migración con la CLI @@ -19,23 +19,23 @@ Este comando: * Analiza la estructura de navegación de tu `docs.json`. * Identifica las páginas MDX que generan páginas de endpoints de OpenAPI. -* Extrae el contenido de los archivos MDX y lo mueve a la extensión `x-mint` en tu especificación de OpenAPI. -* Actualiza tu `docs.json` para hacer referencia directamente a los endpoints de OpenAPI en lugar de a los archivos MDX. -* Elimina los archivos MDX originales de endpoints. +* Extrae el contenido de los archivos MDX y lo traslada a la extensión `x-mint` en tu especificación de OpenAPI. +* Actualiza tu `docs.json` para referenciar directamente los endpoints de OpenAPI en lugar de los archivos MDX. +* Elimina los archivos originales de endpoints en MDX. Si ya tienes `x-mint` definido para un endpoint y también tienes una página MDX con contenido para ese endpoint, el contenido de MDX sobrescribirá la configuración existente de `x-mint`. - Si tienes varias páginas MDX para el mismo endpoint con contenido diferente, el script usará el contenido de la página que aparezca al final en tu `docs.json`. + Si tienes varias páginas MDX para el mismo endpoint con contenido diferente, el script usará el contenido de la página que aparezca de última en tu `docs.json`. - La herramienta de migración no admite la vista previa de los cambios antes de aplicarlos. + La herramienta de migración no admite previsualizar los cambios antes de aplicarlos. - Asegúrate de que tu especificación de OpenAPI sea válida e incluya todos los endpoints que quieres documentar. + Asegúrate de que tu especificación de OpenAPI sea válida e incluya todos los endpoints que deseas documentar. - Cualquier página MDX que quieras migrar debe tener el frontmatter `openapi:` con referencia a un endpoint. + Cualquier página MDX que quieras migrar debe tener el frontmatter `openapi:` que haga referencia a un endpoint. Valida tu archivo de OpenAPI usando el [Swagger Editor](https://editor.swagger.io/) o la [CLI de Mint](https://www.npmjs.com/package/mint). @@ -59,19 +59,19 @@ Este comando: - Asegúrate de que tu especificación de OpenAPI sea válida e incluya todos los endpoints que deseas documentar. + Asegúrate de que tu especificación de OpenAPI sea válida e incluya todos los endpoints que quieres documentar. - Para cualquier endpoint cuyo metadato o contenido quieras personalizar, agrega la extensión `x-mint` al endpoint. Consulta [extensión x-mint](/es/api-playground/openapi-setup#x-mint-extension) para más detalles. + Para los endpoints cuyos metadatos o contenido quieras personalizar, añade la extensión `x-mint` al endpoint. Consulta [extensión x-mint](/es/api-playground/openapi-setup#x-mint-extension) para más detalles. - Para cualquier endpoint que quieras excluir de tu documentación, agrega la extensión `x-hidden` al endpoint. + Para los endpoints que quieras excluir de tu documentación, añade la extensión `x-hidden` al endpoint. - Valida tu archivo de OpenAPI con el [Swagger Editor](https://editor.swagger.io/) o la [CLI de Mint](https://www.npmjs.com/package/mint). + Valida tu archivo de OpenAPI usando el [Swagger Editor](https://editor.swagger.io/) o la [CLI de Mint](https://www.npmjs.com/package/mint). - Reemplaza las referencias a páginas `MDX` por endpoints de OpenAPI en tu `docs.json`. + Reemplaza las referencias de páginas `MDX` por endpoints de OpenAPI en tu `docs.json`. ```json "navigation": { @@ -96,7 +96,7 @@ Este comando: - Después de verificar que tu nueva navegación funciona correctamente, elimina los archivos de endpoint `MDX` que ya no necesitas. + Después de verificar que tu nueva navegación funcione correctamente, elimina los archivos de endpoint `MDX` que ya no necesites. @@ -116,13 +116,13 @@ Combina páginas de API generadas automáticamente con otras páginas: "navigation": { "groups": [ { - "group": "API Reference", + "group": "Referencia de la API", "openapi": "openapi.json", "pages": [ "api/overview", "GET /users", "POST /users", - "api/authentication" + "api/autenticación" ] } ] @@ -130,10 +130,10 @@ Combina páginas de API generadas automáticamente con otras páginas: ```
- ### Varias versiones de la API + ### Varias versiones de API
-Organiza diferentes versiones de la API usando pestañas o grupos: +Organiza distintas versiones de la API usando pestañas o grupos: ```json "navigation": { @@ -156,8 +156,8 @@ Organiza diferentes versiones de la API usando pestañas o grupos: Considera mantener páginas `MDX` individuales cuando necesites: -* Contenido personalizado amplio por endpoint, como componentes de React o ejemplos extensos. -* Diseños de página exclusivos. +* Contenido personalizado extenso por endpoint, como componentes de React o ejemplos largos. +* Diseños de página únicos. * Enfoques de documentación experimentales para endpoints específicos. -Para la mayoría de los casos de uso, la navegación de OpenAPI ofrece mejor mantenibilidad y consistencia. +Para la mayoría de los casos de uso, la navegación de OpenAPI ofrece mejor mantenibilidad y coherencia. diff --git a/es/api-playground/openapi-setup.mdx b/es/api-playground/openapi-setup.mdx index 441413387..fec47985b 100644 --- a/es/api-playground/openapi-setup.mdx +++ b/es/api-playground/openapi-setup.mdx @@ -1,34 +1,34 @@ --- title: "Configuración de OpenAPI" -description: "Referencia endpoints de OpenAPI en tus páginas de documentación" +description: "Incluye endpoints de OpenAPI en las páginas de tu documentación" icon: "file-json" --- -OpenAPI es una especificación para describir APIs. Mintlify es compatible con documentos de OpenAPI 3.0+ para generar documentación de API interactiva y mantenerla actualizada. +OpenAPI es una especificación para describir APIs. Mintlify admite documentos de OpenAPI 3.0+ para generar documentación de API interactiva y mantenerla actualizada.
- ## Agrega un archivo de especificación OpenAPI + ## Agregar un archivo de especificación de OpenAPI
-Para documentar tus endpoints con OpenAPI, necesitas un documento OpenAPI válido en formato JSON o YAML que cumpla con la [especificación OpenAPI 3.0+](https://swagger.io/specification/). +Para documentar tus endpoints con OpenAPI, necesitas un documento de OpenAPI válido en formato JSON o YAML que cumpla con la [especificación OpenAPI 3.0+](https://swagger.io/specification/). -Puedes crear páginas de API a partir de uno o varios documentos OpenAPI. +Puedes crear páginas de API a partir de uno o varios documentos de OpenAPI.
- ### Descripción de tu API + ### Describir tu API
-Recomendamos los siguientes recursos para aprender y crear tus documentos OpenAPI. +Recomendamos los siguientes recursos para aprender a crear y estructurar tus documentos de OpenAPI. * [Guía de OpenAPI de Swagger](https://swagger.io/docs/specification/v3_0/basic-structure/) para aprender la sintaxis de OpenAPI. -* [Fuentes Markdown de la especificación OpenAPI](https://github.com/OAI/OpenAPI-Specification/blob/main/versions/) para consultar los detalles de la especificación OpenAPI más reciente. -* [Swagger Editor](https://editor.swagger.io/) para editar, validar y depurar tu documento OpenAPI. -* [La CLI de Mint](https://www.npmjs.com/package/mint) para validar tu documento OpenAPI con el comando: `mint openapi-check `. +* [Fuentes Markdown de la especificación de OpenAPI](https://github.com/OAI/OpenAPI-Specification/blob/main/versions/) para consultar los detalles de la especificación OpenAPI más reciente. +* [Swagger Editor](https://editor.swagger.io/) para editar, validar y depurar tu documento de OpenAPI. +* [La CLI de Mint](https://www.npmjs.com/package/mint) para validar tu documento de OpenAPI con el comando: `mint openapi-check `. - La Guía de OpenAPI de Swagger corresponde a OpenAPI v3.0, pero casi toda la información + La Guía de OpenAPI de Swagger es para OpenAPI v3.0, pero casi toda la información es aplicable a v3.1. Para obtener más información sobre las diferencias entre v3.0 - y v3.1, consulta [Migrating from OpenAPI 3.0 to + y v3.1, consulta [Migración de OpenAPI 3.0 a 3.1.0](https://www.openapis.org/blog/2021/02/16/migrating-from-openapi-3-0-to-3-1-0) en el blog de OpenAPI. @@ -37,7 +37,7 @@ Recomendamos los siguientes recursos para aprender y crear tus documentos OpenAP ### Especificar la URL de tu API
-Para habilitar funciones de Mintlify como el Área de pruebas de API, agrega un campo `servers` a tu documento OpenAPI con la URL base de tu API. +Para habilitar funciones de Mintlify como el Área de pruebas de API, agrega un campo `servers` a tu documento de OpenAPI con la URL base de tu API. ```json { @@ -49,23 +49,23 @@ Para habilitar funciones de Mintlify como el Área de pruebas de API, agrega un } ``` -En un documento OpenAPI, los diferentes endpoints de la API se especifican por sus rutas, como `/users/{id}` o simplemente `/`. La URL base define dónde se deben anexar estas rutas. Para obtener más información sobre cómo configurar el campo `servers`, consulta [API Server and Base Path](https://swagger.io/docs/specification/api-host-and-base-path/) en la documentación de OpenAPI. +En un documento de OpenAPI, los distintos endpoints de la API se especifican por sus rutas, como `/users/{id}` o simplemente `/`. La URL base define dónde deben añadirse estas rutas. Para más información sobre cómo configurar el campo `servers`, consulta [API Server and Base Path](https://swagger.io/docs/specification/api-host-and-base-path/) en la documentación de OpenAPI. El Área de pruebas de API usa estas URL de servidor para determinar adónde enviar las solicitudes. Si especificas varios servidores, un menú desplegable permitirá a los usuarios alternar entre ellos. Si no especificas un servidor, el Área de pruebas de API usará el modo simple, ya que no puede enviar solicitudes sin una URL base. -Si tu API tiene endpoints que existen en diferentes URL, puedes [sobrescribir el campo de servidores](https://swagger.io/docs/specification/v3_0/api-host-and-base-path/#overriding-servers) para una ruta u operación específica. +Si tu API tiene endpoints que existen en diferentes URL, puedes [sobrescribir el campo de servidor](https://swagger.io/docs/specification/v3_0/api-host-and-base-path/#overriding-servers) para una ruta u operación específica.
### Especificar la autenticación
-Para habilitar la autenticación en tu documentación y en el área de pruebas de la API, configura los campos `securitySchemes` y `security` en tu documento OpenAPI. Las descripciones de la API y el Área de pruebas de API agregarán campos de autenticación basados en las configuraciones de seguridad de tu documento OpenAPI. +Para habilitar la autenticación en tu documentación y en el área de pruebas de la API, configura los campos `securitySchemes` y `security` en tu documento de OpenAPI. Las descripciones de la API y el Área de pruebas de API añadirán campos de autenticación según las configuraciones de seguridad de tu documento de OpenAPI. - + Agrega un campo `securitySchemes` para definir cómo se autentican los usuarios. - Este ejemplo muestra una configuración para autenticación tipo bearer. + Este ejemplo muestra una configuración para autenticación bearer. ```json { @@ -81,7 +81,7 @@ Para habilitar la autenticación en tu documentación y en el área de pruebas d ``` - + Agrega un campo `security` para requerir autenticación. ```json @@ -100,41 +100,41 @@ Los tipos comunes de autenticación incluyen: * [API Keys](https://swagger.io/docs/specification/authentication/api-keys/): Para claves en encabezado, query o cookie. * [Bearer](https://swagger.io/docs/specification/authentication/bearer-authentication/): Para tokens JWT u OAuth. -* [Basic](https://swagger.io/docs/specification/authentication/basic-authentication/): Para usuario y contraseña. +* [Basic](https://swagger.io/docs/specification/authentication/basic-authentication/): Para nombre de usuario y contraseña. Si distintos endpoints de tu API requieren diferentes métodos de autenticación, puedes [sobrescribir el campo de seguridad](https://swagger.io/docs/specification/authentication/#:~:text=you%20can%20apply%20them%20to%20the%20whole%20API%20or%20individual%20operations%20by%20adding%20the%20security%20section%20on%20the%20root%20level%20or%20operation%20level%2C%20respectively.) para una operación específica. -Para obtener más información sobre cómo definir y aplicar la autenticación, consulta [Authentication](https://swagger.io/docs/specification/authentication/) en la documentación de OpenAPI. +Para más información sobre cómo definir y aplicar la autenticación, consulta [Authentication](https://swagger.io/docs/specification/authentication/) en la documentación de OpenAPI.
- ## `x-mint` extension + ## Extensión `x-mint`
-La extensión `x-mint` es una extensión personalizada de OpenAPI que ofrece control adicional sobre cómo se genera y se muestra la documentación de tu API. +La extensión `x-mint` es una extensión personalizada de OpenAPI que ofrece un mayor control sobre cómo se genera y se muestra la documentación de tu API.
- ### Metadata + ### Metadatos
-Sobrescribe los metadatos predeterminados de las páginas de API generadas añadiendo `x-mint: metadata` a cualquier operación. Puedes usar cualquier campo de metadatos válido en el frontmatter de `MDX`, excepto `openapi`: +Sobrescribe los metadatos predeterminados de las páginas de API generadas agregando `x-mint: metadata` a cualquier operación. Puedes usar cualquier campo de metadatos válido en el frontmatter de `MDX`, excepto `openapi`: ```json {7-13} { "paths": { "/users": { "get": { - "summary": "Get users", - "description": "Retrieve a list of users", + "summary": "Obtener usuarios", + "description": "Obtener una lista de usuarios", "x-mint": { "metadata": { - "title": "List all users", - "description": "Fetch paginated user data with filtering options", - "og:title": "Display a list of users" + "title": "Listar todos los usuarios", + "description": "Obtener datos de usuarios paginados con opciones de filtrado", + "og:title": "Mostrar una lista de usuarios", } }, "parameters": [ { - // Parameter configuration + // Configuración del parámetro } ] } @@ -144,19 +144,19 @@ Sobrescribe los metadatos predeterminados de las páginas de API generadas añad ```
- ### Content + ### Contenido
-Añade contenido antes de la documentación de API autogenerada usando `x-mint: content`: +Agrega contenido antes de la documentación de API generada automáticamente usando `x-mint: content`: ```json {6-8} { "paths": { "/users": { "post": { - "summary": "Create user", + "summary": "Crear usuario", "x-mint": { - "content": "## Requisitos previos\n\nEste endpoint requiere privilegios de administrador y tiene limitación de tasa.\n\nLos correos electrónicos de usuario deben ser únicos en todo el sistema." + "content": "## Requisitos previos\n\nEste endpoint requiere privilegios de administrador y tiene límites de tasa.\n\nLas direcciones de correo electrónico de los usuarios deben ser únicas en todo el sistema." }, "parameters": [ { @@ -182,7 +182,7 @@ Cambia la URL de la página del endpoint en tu documentación usando `x-mint: hr "paths": { "/legacy-endpoint": { "get": { - "summary": "Legacy endpoint", + "summary": "Endpoint heredado", "x-mint": { "href": "/deprecated-endpoints/legacy-endpoint" } @@ -190,7 +190,7 @@ Cambia la URL de la página del endpoint en tu documentación usando `x-mint: hr }, "/documented-elsewhere": { "post": { - "summary": "Special endpoint", + "summary": "Endpoint especial" "x-mint": { "href": "/guides/special-endpoint-guide" } @@ -206,14 +206,14 @@ Cuando `x-mint: href` está presente, la entrada de navegación enlaza directame ### MCP
-Expón selectivamente endpoints como herramientas del Model Context Protocol (MCP) usando `x-mint: mcp`. Habilita solo los endpoints que sean seguros para el acceso público mediante herramientas de IA. +Expón selectivamente endpoints como herramientas del Model Context Protocol (MCP) usando `x-mint: mcp`. Habilita solo los endpoints que sean seguros para el acceso público a través de herramientas de IA. La configuración de MCP para el endpoint. - Indica si se expone el endpoint como una herramienta MCP. Tiene prioridad sobre la configuración a nivel de archivo. + Indica si se expone el endpoint como herramienta MCP. Tiene prioridad sobre la configuración a nivel de archivo. @@ -277,7 +277,7 @@ Expón selectivamente endpoints como herramientas del Model Context Protocol (MC Para obtener más información, consulta [Model Context Protocol](/es/ai/model-context-protocol).
- ## Autogenerar páginas de API + ## Rellenar automáticamente páginas de API
Agrega un campo `openapi` a cualquier elemento de navegación en tu `docs.json` para generar automáticamente páginas para endpoints de OpenAPI. Puedes controlar dónde aparecen estas páginas en tu estructura de navegación, ya sea como secciones de API dedicadas o junto con otras páginas. @@ -286,21 +286,21 @@ El campo `openapi` acepta una ruta de archivo en tu repositorio de documentació Las páginas de endpoints generadas tienen estos metadatos predeterminados: -* `title`: El campo `summary` de la operación, si está presente. Si no hay `summary`, el título se genera a partir del método HTTP y el endpoint. +* `title`: El campo `summary` de la operación, si está presente. Si no hay `summary`, el título se genera a partir del método HTTP y del endpoint. * `description`: El campo `description` de la operación, si está presente. -* `version`: El valor `version` del ancla o pestaña superior, si está presente. -* `deprecated`: El campo `deprecated` de la operación. Si es `true`, aparecerá una etiqueta de “obsoleta” junto al título del endpoint en la navegación lateral y en la página del endpoint. +* `version`: El valor de `version` del ancla o pestaña principal, si está presente. +* `deprecated`: El campo `deprecated` de la operación. Si es `true`, aparecerá una etiqueta de “deprecated” junto al título del endpoint en la navegación lateral y en la página del endpoint. - Para excluir endpoints específicos de tus páginas de API autogeneradas, agrega la propiedad + Para excluir endpoints específicos de tus páginas de API generadas automáticamente, agrega la propiedad [x-hidden](/es/api-playground/customization/managing-page-visibility#x-hidden) a la operación en tu especificación de OpenAPI. Hay dos enfoques para agregar páginas de endpoints a tu documentación: -1. **Secciones de API dedicadas**: Hace referencia a especificaciones de OpenAPI en elementos de navegación para secciones de API dedicadas. -2. **Endpoints selectivos**: Hace referencia a endpoints específicos en tu navegación junto con otras páginas. +1. **Secciones de API dedicadas**: Referencia especificaciones de OpenAPI en elementos de navegación para secciones de API dedicadas. +2. **Endpoints selectivos**: Referencia endpoints específicos en tu navegación junto con otras páginas.
### Secciones de API dedicadas @@ -312,7 +312,7 @@ Genera secciones de API dedicadas agregando un campo `openapi` a un elemento de "navigation": { "tabs": [ { - "tab": "API Reference", + "tab": "Referencia de la API" "openapi": "https://petstore3.swagger.io/api/v3/openapi.json" } ] @@ -325,17 +325,17 @@ Puedes usar varias especificaciones de OpenAPI en diferentes secciones de navega "navigation": { "tabs": [ { - "tab": "API Reference", + "tab": "Referencia de la API", "groups": [ { - "group": "Users", + "group": "Usuarios", "openapi": { "source": "/path/to/openapi-1.json", "directory": "api-reference" } }, { - "group": "Admin", + "group": "Administración" "openapi": { "source": "/path/to/openapi-2.json", "directory": "api-reference" @@ -349,34 +349,34 @@ Puedes usar varias especificaciones de OpenAPI en diferentes secciones de navega El campo `directory` es opcional y especifica dónde se almacenan las páginas de API generadas - en tu repositorio de documentación. Si no se especifica, el valor predeterminado es el directorio - `api-reference` de tu repositorio. + en tu repositorio de documentación. Si no se especifica, se usará por defecto el directorio `api-reference` + de tu repositorio.
### Endpoints selectivos
-Cuando quieras más control sobre dónde aparecen los endpoints en tu documentación, puedes hacer referencia a endpoints específicos en tu navegación. Este enfoque te permite generar páginas de endpoints de API junto con otros contenidos. +Cuando necesites más control sobre dónde aparecen los endpoints en tu documentación, puedes referenciar endpoints específicos en la navegación. Este enfoque te permite generar páginas para endpoints de API junto con otros contenidos.
- #### Establecer una especificación de OpenAPI predeterminada + #### Definir una especificación OpenAPI predeterminada
-Configura una especificación de OpenAPI predeterminada para un elemento de navegación. Luego, hace referencia a endpoints específicos en el campo `pages`: +Configura una especificación OpenAPI predeterminada para un elemento de navegación. Luego referencia endpoints específicos en el campo `pages`: ```json {12, 15-16} "navigation": { "tabs": [ { - "tab": "Getting started", + "tab": "Primeros pasos", "pages": [ "quickstart", "installation" ] }, { - "tab": "API reference", + "tab": "Referencia de la API", "openapi": "/path/to/openapi.json", "pages": [ "api-overview", @@ -389,17 +389,17 @@ Configura una especificación de OpenAPI predeterminada para un elemento de nave } ``` -Cualquier entrada de página que coincida con el formato `METHOD /path` generará una página de API para ese endpoint usando la especificación de OpenAPI predeterminada. +Cualquier entrada de página que coincida con el formato `METHOD /path` generará una página de API para ese endpoint usando la especificación predeterminada de OpenAPI.
#### Herencia de la especificación de OpenAPI
-Las especificaciones de OpenAPI se heredan a lo largo de la jerarquía de navegación. Los elementos de navegación secundarios heredan la especificación de OpenAPI de su elemento padre, a menos que definan la suya propia: +Las especificaciones de OpenAPI se heredan a lo largo de la jerarquía de navegación. Los elementos de navegación secundarios heredan la especificación de OpenAPI de su elemento principal, a menos que definan la suya propia: ```json {3, 7-8, 11, 13-14} { - "group": "API reference", + "group": "Referencia de la API", "openapi": "/path/to/openapi-v1.json", "pages": [ "overview", @@ -407,7 +407,7 @@ Las especificaciones de OpenAPI se heredan a lo largo de la jerarquía de navega "GET /users", "POST /users", { - "group": "Orders", + "group": "Pedidos", "openapi": "/path/to/openapi-v2.json", "pages": [ "GET /orders", @@ -427,41 +427,41 @@ Hace referencia a endpoints específicos sin establecer una especificación de O ```json {5-6} "navigation": { "pages": [ - "introduction", - "user-guides", + "introducción", + "guías de usuario" "/path/to/openapi-v1.json POST /users", "/path/to/openapi-v2.json GET /orders" ] } ``` -Este enfoque es útil cuando necesitas endpoints individuales de diferentes especificaciones o solo quieres incluir endpoints seleccionados. +Este enfoque es útil cuando necesitas endpoints individuales de distintas especificaciones o solo quieres incluir algunos endpoints seleccionados.
## Crear archivos `MDX` para páginas de API
-Para tener control sobre páginas de endpoints individuales, crea páginas `MDX` para cada operación. Esto te permite personalizar los metadatos de la página, agregar contenido, omitir ciertas operaciones o reordenar páginas en la navegación a nivel de página. +Para controlar páginas de endpoints individuales, crea páginas `MDX` para cada operación. Esto te permite personalizar los metadatos de la página, añadir contenido, omitir ciertas operaciones o reordenar páginas en tu navegación a nivel de página. -Consulta un [ejemplo de página MDX de OpenAPI de MindsDB](https://github.com/mindsdb/mindsdb/blob/main/docs/rest/databases/create-databases.mdx?plain=1) y cómo aparece en su [documentación publicada](https://docs.mindsdb.com/rest/databases/create-databases). +Consulta un [ejemplo de página de OpenAPI en MDX de MindsDB](https://github.com/mindsdb/mindsdb/blob/main/docs/rest/databases/create-databases.mdx?plain=1) y cómo aparece en su [documentación en producción](https://docs.mindsdb.com/rest/databases/create-databases).
### Especificar archivos manualmente
-Crea una página `MDX` para cada endpoint y especifica qué operación de OpenAPI mostrar usando el campo `openapi` en el frontmatter. +Crea una página `MDX` para cada endpoint y especifica qué operación de OpenAPI mostrar utilizando el campo `openapi` en el frontmatter. -Cuando haces referencia a una operación de OpenAPI de esta forma, el nombre, la descripción, los parámetros, las respuestas y el Área de pruebas de API se generan automáticamente a partir de tu documento de OpenAPI. +Cuando haces referencia a una operación de OpenAPI de esta manera, el nombre, la descripción, los parámetros, las respuestas y el Área de pruebas de API se generan automáticamente a partir de tu documento de OpenAPI. Si tienes varios archivos de OpenAPI, incluye la ruta del archivo en tu referencia para asegurarte de que Mintlify encuentre el documento de OpenAPI correcto. Si solo tienes un archivo de OpenAPI, Mintlify lo detectará automáticamente. - Este enfoque funciona independientemente de si has configurado una especificación de OpenAPI predeterminada + Este enfoque funciona independientemente de si has establecido una especificación de OpenAPI predeterminada en tu navegación. Puedes hacer referencia a cualquier endpoint de cualquier especificación de OpenAPI incluyendo la ruta del archivo en el frontmatter. -Si quieres hacer referencia a un archivo externo de OpenAPI, agrega la URL del archivo a tu `docs.json`. +Si deseas hacer referencia a un archivo externo de OpenAPI, añade la URL del archivo a tu `docs.json`. ```mdx Example @@ -487,24 +487,24 @@ Si quieres hacer referencia a un archivo externo de OpenAPI, agrega la URL del a El método y la ruta deben coincidir exactamente con la definición en tu especificación de OpenAPI. - Si el endpoint no existe en el archivo de OpenAPI, la página estará vacía. + Si el endpoint no existe en el archivo de OpenAPI, la página quedará vacía.
### Generar archivos `MDX` automáticamente
-Usa nuestro [scraper](https://www.npmjs.com/package/@mintlify/scraping) de Mintlify para generar automáticamente páginas `MDX` para documentos de OpenAPI grandes. +Utiliza nuestro [scraper](https://www.npmjs.com/package/@mintlify/scraping) de Mintlify para generar automáticamente páginas `MDX` para documentos de OpenAPI grandes. - Tu documento de OpenAPI debe ser válido o no se generarán los archivos. + Tu documento de OpenAPI debe ser válido o los archivos no se generarán automáticamente. El scraper genera: * Una página `MDX` por cada operación en el campo `paths` de tu documento de OpenAPI. * Si tu documento de OpenAPI es versión 3.1+, una página `MDX` por cada operación en el campo `webhooks` de tu documento de OpenAPI. -* Un arreglo de entradas de navegación que puedes agregar a tu `docs.json`. +* Un array de entradas de navegación que puedes añadir a tu `docs.json`. @@ -518,7 +518,7 @@ El scraper genera: npx @mintlify/scraping@latest openapi-file -o api-reference ``` - Agrega la opción `-o` para especificar una carpeta donde colocar los archivos. Si no se especifica una carpeta, los archivos se crearán en el directorio de trabajo. + Añade la opción `-o` para indicar una carpeta donde guardar los archivos. Si no se especifica una carpeta, los archivos se crearán en el directorio de trabajo. @@ -552,7 +552,7 @@ Los webhooks son devoluciones de llamada HTTP que tu API envía para notificar a ### Define webhooks en tu especificación de OpenAPI
-Añade un campo `webhooks` a tu documento de OpenAPI junto al campo `paths`. +Agrega un campo `webhooks` a tu documento de OpenAPI junto al campo `paths`. Para obtener más información sobre cómo definir webhooks, consulta [Webhooks](https://spec.openapis.org/oas/v3.1.0#oasWebhooks) en la documentación de OpenAPI. @@ -564,13 +564,13 @@ Al crear páginas MDX para webhooks, usa `webhook` en lugar de métodos HTTP com ```mdx --- -title: "Example webhook" -description: "Triggered when an event occurs" +title: "Webhook de ejemplo" +description: "Se activa cuando se produce un evento" openapi: "path/to/openapi-file webhook example-webhook-name" --- ``` - El nombre del webhook debe coincidir exactamente con la clave definida en el campo `webhooks` de tu - especificación de OpenAPI. + El nombre del webhook debe coincidir exactamente con la clave definida en el campo `webhooks` + de tu especificación de OpenAPI. diff --git a/es/api-playground/overview.mdx b/es/api-playground/overview.mdx index 2e6477cff..ba79a935c 100644 --- a/es/api-playground/overview.mdx +++ b/es/api-playground/overview.mdx @@ -1,6 +1,6 @@ --- -title: "Área de pruebas" -description: "Permite a los usuarios interactuar con tu API" +title: "Playground" +description: "Permite que los usuarios interactúen con tu API" icon: "play" --- @@ -8,7 +8,7 @@ icon: "play" ## Descripción general -El área de pruebas de API es un entorno interactivo que permite a los usuarios probar y explorar tus endpoints de API. Los desarrolladores pueden crear solicitudes de API, enviarlas y ver las respuestas sin salir de tu documentación. +El Área de pruebas de API es un entorno interactivo que permite a los usuarios probar y explorar tus endpoints de API. Los desarrolladores pueden crear solicitudes de API, enviarlas y ver las respuestas sin salir de tu documentación. Área de pruebas de API para el endpoint que activa una actualización. @@ -16,29 +16,29 @@ El área de pruebas de API es un entorno interactivo que permite a los usuarios Área de pruebas de API para el endpoint que activa una actualización. -El área de pruebas se genera automáticamente a partir de tu especificación de OpenAPI o del esquema de AsyncAPI, por lo que cualquier actualización de tu API se refleja automáticamente en ella. También puedes crear manualmente páginas de referencia de API después de definir una URL base y un método de autenticación en tu `docs.json`. +El Área de pruebas se genera automáticamente a partir de tu especificación OpenAPI o del esquema AsyncAPI, por lo que cualquier actualización de tu API se refleja automáticamente allí. También puedes crear manualmente páginas de referencia de API después de definir una URL base y un método de autenticación en tu `docs.json`. -Recomendamos generar tu área de pruebas de API a partir de una especificación de OpenAPI. Consulta [OpenAPI Setup](/es/api-playground/openapi-setup) para obtener más información sobre cómo crear tu documento de OpenAPI. +Recomendamos generar tu Área de pruebas de API a partir de una especificación OpenAPI. Consulta [Configuración de OpenAPI](/es/api-playground/openapi-setup) para obtener más información sobre cómo crear tu documento de OpenAPI.
## Primeros pasos
- + - Asegúrate de que tu archivo de especificación de OpenAPI sea válido usando el [Swagger Editor](https://editor.swagger.io/) o la [CLI de Mint](https://www.npmjs.com/package/mint). + Asegúrate de que tu archivo de especificación de OpenAPI sea válido usando el [Swagger Editor](https://editor.swagger.io/) o el [Mint CLI](https://www.npmjs.com/package/mint). - ```bash {2} + ```bash {3} /your-project |- docs.json |- openapi.json ``` - - Actualiza tu `docs.json` para hacer referencia a tu especificación de OpenAPI. Agrega una propiedad `openapi` a cualquier elemento de navegación para completar automáticamente tu documentación con páginas para cada endpoint especificado en tu documento de OpenAPI. + + Actualiza tu `docs.json` para hacer referencia a tu especificación de OpenAPI. Agrega una propiedad `openapi` a cualquier elemento de navegación para rellenar automáticamente tu documentación con páginas para cada endpoint especificado en tu documento de OpenAPI. Este ejemplo genera una página para cada endpoint especificado en `openapi.json` y las organiza en el grupo "API reference" de tu navegación. @@ -55,7 +55,7 @@ Recomendamos generar tu área de pruebas de API a partir de una especificación Para generar páginas solo para endpoints específicos, enumera los endpoints en la propiedad `pages` del elemento de navegación. - Este ejemplo genera páginas solo para los endpoints `GET /users` y `POST /users`. Para generar otras páginas de endpoints, agrega más endpoints al arreglo `pages`. + Este ejemplo genera páginas solo para los endpoints `GET /users` y `POST /users`. Para generar otras páginas de endpoints, agrega endpoints adicionales al arreglo `pages`. ```json "navigation": { @@ -78,84 +78,84 @@ Recomendamos generar tu área de pruebas de API a partir de una especificación ## Personalizar tu área de pruebas -Puedes personalizar tu área de pruebas de API definiendo las siguientes propiedades en tu `docs.json`. +Puedes personalizar tu Área de pruebas de API definiendo las siguientes propiedades en tu `docs.json`. - Configuraciones del área de pruebas de API. + Configuración del Área de pruebas de API. - El modo de visualización del área de pruebas de API. + El modo de visualización del Área de pruebas de API. * `"interactive"`: Muestra el área de pruebas interactiva. * `"simple"`: Muestra un endpoint copiable sin área de pruebas. * `"none"`: No muestra nada. - De forma predeterminada es `interactive`. + Valor predeterminado: `interactive`. - Indica si las solicitudes de API deben pasar por un servidor proxy. De forma predeterminada es `true`. + Indica si las solicitudes de API se enrutan a través de un servidor proxy. Valor predeterminado: `true`. - Configuraciones para los ejemplos de API autogenerados. + Configuración de los ejemplos de API generados automáticamente. - Lenguajes de ejemplo para los Fragmentos de API autogenerados. + Lenguajes para los Fragmentos de API generados automáticamente. - Los lenguajes se muestran en el orden especificado. + Se muestran en el orden especificado. - Indica si se deben mostrar los parámetros opcionales en los ejemplos de API. De forma predeterminada es `all`. + Indica si se muestran los parámetros opcionales en los ejemplos de API. Valor predeterminado: `all`.
- ### Configuración de ejemplo + ### Ejemplo de configuración
```json { "api": { "playground": { - "display": "interactive" + "display": "interactivo" }, "examples": { "languages": ["curl", "python", "javascript"], - "defaults": "required" + "defaults": "obligatorio" } } } ``` -Este ejemplo configura el área de pruebas de API para que sea interactiva, con Fragmentos de código de ejemplo para cURL, Python y JavaScript. Solo se muestran los parámetros obligatorios en los Fragmentos de código. +Este ejemplo configura el área de pruebas de API para que sea interactiva e incluya fragmentos de código de ejemplo para cURL, Python y JavaScript. Solo se muestran los parámetros obligatorios en los fragmentos de código.
- ### Páginas de endpoints personalizadas + ### Páginas personalizadas de endpoints
-Cuando necesites más control sobre tu documentación de API, usa la extensión `x-mint` en tu especificación de OpenAPI o crea páginas `MDX` individuales para tus endpoints. +Cuando necesites más control sobre la documentación de tu API, usa la extensión `x-mint` en tu especificación de OpenAPI o crea páginas `MDX` individuales para tus endpoints. Ambas opciones te permiten: * Personalizar los metadatos de la página -* Agregar contenido adicional como ejemplos -* Controlar el comportamiento del área de pruebas por página +* Agregar contenido adicional, como ejemplos +* Controlar el comportamiento del playground por página Se recomienda la extensión `x-mint` para que toda tu documentación de API se genere automáticamente a partir de tu especificación de OpenAPI y se mantenga en un solo archivo. -Se recomiendan las páginas `MDX` individuales para API pequeñas o cuando quieras experimentar con cambios por página. +Se recomiendan las páginas `MDX` individuales para APIs pequeñas o cuando quieras experimentar con cambios por página. -Para obtener más información, consulta [x-mint extension](/es/api-playground/openapi-setup#x-mint-extension) y [MDX Setup](/es/api-playground/mdx/configuration). +Para obtener más información, consulta [Extensión x-mint](/es/api-playground/openapi-setup#x-mint-extension) y [Configuración de MDX](/es/api-playground/mdx/configuration).
- ## Lecturas recomendadas + ## Lecturas adicionales
-* [Configuración de AsyncAPI](/es/api-playground/asyncapi/setup) para obtener más información sobre cómo crear tu esquema de AsyncAPI y generar páginas de referencia de WebSocket. +* [Configuración de AsyncAPI](/es/api-playground/asyncapi/setup) para obtener más información sobre cómo crear tu esquema de AsyncAPI y generar páginas de referencia de WebSocket. \ No newline at end of file diff --git a/es/api-playground/troubleshooting.mdx b/es/api-playground/troubleshooting.mdx index 2a03d3433..c9ee52a9b 100644 --- a/es/api-playground/troubleshooting.mdx +++ b/es/api-playground/troubleshooting.mdx @@ -1,18 +1,18 @@ --- title: "Solución de problemas" -description: "Problemas comunes en las referencias de API" +description: "Problemas comunes con las referencias de API" icon: "message-square-warning" --- Si tus páginas de API no se muestran correctamente, revisa estos problemas de configuración comunes: - + En este escenario, es probable que Mintlify no pueda encontrar tu documento de OpenAPI o que tu documento de OpenAPI no sea válido. Ejecutar `mint dev` localmente debería revelar algunos de estos problemas. - Para verificar que tu documento de OpenAPI pasará la validación: + Para verificar que tu documento de OpenAPI pase la validación: 1. Visita [este validador](https://editor.swagger.io/) 2. Cambia a la pestaña "Validate text" @@ -20,8 +20,8 @@ Si tus páginas de API no se muestran correctamente, revisa estos problemas de c 4. Haz clic en "Validate it!" Si el cuadro de texto que aparece abajo tiene un borde verde, tu documento ha pasado la validación. - Este es exactamente el mismo paquete de validación que usa Mintlify para validar documentos de OpenAPI, así que si tu documento - pasa la validación aquí, hay muchas probabilidades de que el problema esté en otro lugar. + Este es exactamente el paquete de validación que usa Mintlify para validar documentos de OpenAPI, así que si tu documento + pasa la validación aquí, es muy probable que el problema esté en otro lugar. Además, Mintlify no es compatible con OpenAPI 2.0. Si tu documento usa esta versión de la especificación, podrías encontrarte con este problema. Puedes convertir tu documento en [editor.swagger.io](https://editor.swagger.io/) (en Edit > Convert to OpenAPI 3): @@ -31,8 +31,8 @@ Si tus páginas de API no se muestran correctamente, revisa estos problemas de c - - Esto suele deberse a un error ortográfico en el campo `openapi` de los metadatos de la página. Asegúrate de que el método HTTP y la ruta coincidan exactamente con el método HTTP y la ruta del documento de OpenAPI. + + Esto suele deberse a un campo `openapi` mal escrito en los metadatos de la página. Asegúrate de que el método HTTP y la ruta coincidan exactamente con el método HTTP y la ruta del documento de OpenAPI. Aquí tienes un ejemplo de cómo podría salir mal: @@ -50,25 +50,25 @@ Si tus páginas de API no se muestran correctamente, revisa estos problemas de c Observa que la ruta en el campo `openapi` tiene una barra al final, mientras que la ruta en el documento de OpenAPI no. - Otro problema común es un nombre de archivo mal escrito. Si especificas un documento de OpenAPI en particular en el campo `openapi`, asegúrate de que el nombre del archivo sea correcto. Por ejemplo, si tienes dos documentos de OpenAPI, `openapi/v1.json` y `openapi/v2.json`, tus metadatos podrían verse así: + Otro problema común es un nombre de archivo mal escrito. Si estás especificando un documento de OpenAPI en particular en el campo `openapi`, asegúrate de que el nombre del archivo sea correcto. Por ejemplo, si tienes dos documentos de OpenAPI, `openapi/v1.json` y `openapi/v2.json`, tus metadatos podrían verse así: - ```mdx referencia-api/v1/usuarios/obtener-usuario.mdx + ```mdx referencia-de-api/v1/usuarios/obtener-usuario.mdx --- openapi: "v1 GET /users/{id}" --- ``` - - Si tienes un dominio personalizado configurado, esto podría deberse a tu proxy inverso. De forma predeterminada, las solicitudes realizadas desde el Área de pruebas de API comienzan con una solicitud `POST` a la ruta `/_mintlify/api/request` en el sitio de documentación. Si tu proxy inverso está configurado para permitir únicamente solicitudes `GET`, todas estas solicitudes fallarán. Para solucionarlo, configura tu proxy inverso para permitir solicitudes `POST` a la ruta `/_mintlify/api/request`. + + Si tienes un dominio personalizado configurado, puede tratarse de un problema con tu proxy inverso. De forma predeterminada, las solicitudes realizadas a través del Área de pruebas de API comienzan con una solicitud `POST` a la ruta `/_mintlify/api/request` en el sitio de documentación. Si tu proxy inverso está configurado para permitir solo solicitudes `GET`, todas estas solicitudes fallarán. Para solucionarlo, configura tu proxy inverso para permitir solicitudes `POST` a la ruta `/_mintlify/api/request`. Como alternativa, si tu proxy inverso impide aceptar solicitudes `POST`, puedes configurar Mintlify para enviar solicitudes directamente a tu backend con el ajuste `api.playground.proxy` en el `docs.json`, como se describe en la [documentación de configuración](/es/settings#param-proxy). Al usar esta configuración, deberás configurar CORS en tu servidor, ya que las solicitudes vendrán directamente desde los navegadores de los usuarios en lugar de pasar por tu proxy. - - Si usas una configuración de navegación de OpenAPI pero las páginas no se generan, revisa estos problemas comunes: + + Si utilizas una configuración de navegación de OpenAPI pero las páginas no se generan, revisa estos problemas comunes: - 1. **Falta la especificación predeterminada de OpenAPI**: Asegúrate de tener un campo `openapi` definido para el elemento de navegación: + 1. **Falta la especificación predeterminada de OpenAPI**: Asegúrate de tener definido un campo `openapi` para el elemento de navegación: ```json {5} "navigation": { @@ -90,17 +90,17 @@ Si tus páginas de API no se muestran correctamente, revisa estos problemas de c 3. **Problemas de validación**: Usa `mint openapi-check ` para verificar que tu documento de OpenAPI sea válido. - + 1. **Operaciones ocultas**: Las operaciones marcadas con `x-hidden: true` en tu especificación de OpenAPI no aparecerán en la navegación generada automáticamente. 2. **Operaciones no válidas**: Las operaciones con errores de validación en la especificación de OpenAPI pueden omitirse. Revisa tu documento de OpenAPI para detectar errores de sintaxis. - 3. **Inclusión manual vs. automática**: Si haces referencia a endpoints de una especificación de OpenAPI, solo las operaciones referenciadas explícitamente aparecerán en la navegación. No se agregarán otras páginas automáticamente. Esto incluye operaciones referenciadas en elementos de navegación secundarios. + 3. **Inclusión manual vs. automática**: Si haces referencia a endpoints de una especificación de OpenAPI, solo las operaciones referenciadas explícitamente aparecerán en la navegación. No se añadirán otras páginas automáticamente. Esto incluye las operaciones referenciadas en elementos de navegación secundarios. - - Al combinar operaciones de OpenAPI con páginas de documentación en la navegación: + + Al combinar operaciones de OpenAPI con páginas de documentación normales en la navegación: - 1. **Conflictos de archivos**: No puedes tener a la vez un archivo `MDX` y una entrada de navegación para la misma operación. Por ejemplo, si tienes `get-users.mdx`, no incluyas también `"GET /users"` en la navegación. Si necesitas un archivo que comparta nombre con una operación, usa la extensión `x-mint` en el endpoint para que el href apunte a otra ubicación. - 2. **Resolución de rutas**: Las entradas de navegación que no coincidan con operaciones de OpenAPI se tratarán como rutas de archivo. Asegúrate de que tus archivos `MDX` existan en las ubicaciones esperadas. - 3. **Sensibilidad a mayúsculas y minúsculas**: La coincidencia de operaciones de OpenAPI distingue mayúsculas y minúsculas. Asegúrate de que los métodos HTTP estén en mayúsculas en las entradas de navegación. + 1. **Conflictos de archivos**: No puedes tener a la vez un archivo `MDX` y una entrada de navegación para la misma operación. Por ejemplo, si tienes `get-users.mdx`, no incluyas también "GET /users" en tu navegación. Si necesitas un archivo que comparta nombre con una operación, usa la extensión `x-mint` en el endpoint para que el href apunte a otra ubicación. + 2. **Resolución de rutas**: Las entradas de navegación que no coincidan con operaciones de OpenAPI se tratarán como rutas de archivo. Asegúrate de que tus archivos `MDX` existan en las ubicaciones previstas. + 3. **Distingue mayúsculas y minúsculas**: La coincidencia de operaciones de OpenAPI distingue entre mayúsculas y minúsculas. Asegúrate de que los métodos HTTP estén en mayúsculas en las entradas de navegación. \ No newline at end of file diff --git a/es/api-reference/assistant/create-assistant-message.mdx b/es/api-reference/assistant/create-assistant-message.mdx index 517bc582f..911faf52a 100644 --- a/es/api-reference/assistant/create-assistant-message.mdx +++ b/es/api-reference/assistant/create-assistant-message.mdx @@ -20,6 +20,6 @@ La API del Asistente tiene los siguientes límites: ## Uso recomendado -Para obtener mejores resultados, usa el [hook useChat de ai-sdk](https://ai-sdk.dev/docs/reference/ai-sdk-ui/use-chat#usechat) para enviar solicitudes y gestionar respuestas. +Para obtener los mejores resultados, utiliza el [hook useChat de ai-sdk](https://ai-sdk.dev/docs/reference/ai-sdk-ui/use-chat#usechat) para enviar solicitudes y gestionar respuestas. -Puedes configurar `fp`, `threadId` y `filter` en el campo `body` del parámetro de opciones que se pasa al hook. \ No newline at end of file +Puedes establecer `fp`, `threadId` y `filter` en el campo `body` del parámetro de opciones que se pasa al hook. \ No newline at end of file diff --git a/es/api-reference/introduction.mdx b/es/api-reference/introduction.mdx index 5de4e747b..4c57a3604 100644 --- a/es/api-reference/introduction.mdx +++ b/es/api-reference/introduction.mdx @@ -1,10 +1,10 @@ --- title: "Introducción" -description: "Lanza actualizaciones, integra el Asistente de IA y más" +description: "Activar actualizaciones, integrar el Asistente de IA y más" icon: "book-open" --- -La API REST de Mintlify te permite interactuar de forma programática con tu documentación, lanzar actualizaciones e integrar experiencias de chat con IA. +La API REST de Mintlify te permite interactuar con tu documentación de forma programática, activar actualizaciones e integrar experiencias de chat con IA.
## Endpoints @@ -19,28 +19,28 @@ La API REST de Mintlify te permite interactuar de forma programática con tu doc ## Autenticación
-Puedes generar una clave de API desde el [panel](https://dashboard.mintlify.com/settings/organization/api-keys). Las claves de API están asociadas a toda la organización y pueden usarse en múltiples implementaciones. +Puedes generar una clave de API desde el [panel de control](https://dashboard.mintlify.com/settings/organization/api-keys). Las claves de API están asociadas a toda la organización y se pueden usar en múltiples implementaciones.
### Clave de API de administrador
-La clave de API de administrador se utiliza en los endpoints [Trigger update](/es/api-reference/update/trigger) y [Get update status](/es/api-reference/update/status). +La clave de API de administrador se usa para los endpoints [Trigger update](/es/api-reference/update/trigger) y [Get update status](/es/api-reference/update/status). -Las claves de API de administrador comienzan con el prefijo `mint_`. Mantén en secreto tus claves de API de administrador. +Las claves de API de administrador comienzan con el prefijo `mint_`. Mantén tus claves de API de administrador en secreto.
### Clave de API del Asistente
-La clave de API del Asistente se utiliza en los endpoints [Generate assistant message](/es/api-reference/assistant/create-assistant-message) y [Search documentation](/es/api-reference/assistant/search). +La clave de API del Asistente se usa para los endpoints [Generate assistant message](/es/api-reference/assistant/create-assistant-message) y [Search documentation](/es/api-reference/assistant/search). Las claves de API del Asistente comienzan con el prefijo `mint_dsc_`. La **clave** de la API del Asistente es un token del lado del servidor que debe mantenerse en secreto. -El **token** de la API del Asistente es público y puede referenciarse en tu código frontend. +El **token** de la API del Asistente es un token público que puede referenciarse en tu código de frontend. - Las llamadas que usan el token de la API del Asistente pueden generar costos: ya sea consumiendo tus créditos del Asistente de IA o incurriendo en sobrecargos. + Las llamadas que usan el token de la API del Asistente pueden generar costos: ya sea consumiendo tus créditos del Asistente de IA o incurriendo en excedentes. diff --git a/es/assistant-context.mdx b/es/assistant-context.mdx index 855cbde39..9e3129075 100644 --- a/es/assistant-context.mdx +++ b/es/assistant-context.mdx @@ -3,7 +3,7 @@ title: "Contexto del Asistente" description: "Esta página contiene contexto para ayudar al asistente a responder consultas" --- -Para el asistente, consulta esta información cuando respondas a consultas. +Para el Asistente, consulta esta información al responder consultas. -- Si alguien pregunta por el registro de cambios, las actualizaciones recientes o las novedades, remítelos al registro de cambios de Mintlify en https://mintlify.com/docs/changelog -- Si alguien pregunta por las traducciones, proporciona la información que consideres relevante para su pregunta según tu búsqueda y el contexto, y diles que las traducciones automáticas están disponibles como un complemento. Pueden contactar al equipo de ventas (gtm@mintlify.com) para obtener traducciones automáticas. +- Si alguien pregunta por el registro de cambios, las actualizaciones recientes o las novedades, envíalos al registro de cambios de Mintlify en https://mintlify.com/docs/changelog +- Si alguien pregunta por traducciones, proporciona la información que consideres relevante según tu búsqueda y el contexto de su consulta, y comunícales que las traducciones automatizadas están disponibles como complemento. Pueden contactar al equipo de ventas (gtm@mintlify.com) para obtener traducciones automatizadas. diff --git a/es/authentication-personalization/authentication-setup.mdx b/es/authentication-personalization/authentication-setup.mdx index 4b511bfea..8e242a03c 100644 --- a/es/authentication-personalization/authentication-setup.mdx +++ b/es/authentication-personalization/authentication-setup.mdx @@ -1,12 +1,12 @@ --- title: "Configuración de la autenticación" -description: "Controla la privacidad de tu documentación autenticando a los usuarios" +description: "Controla la privacidad de tu documentación mediante la autenticación de usuarios" icon: "file-lock" keywords: ['auth'] --- - Los [planes Pro](https://mintlify.com/pricing?ref=authentication) incluyen autenticación con contraseña. + Los [planes Pro](https://mintlify.com/pricing?ref=authentication) incluyen autenticación por contraseña. Los [planes Enterprise](https://mintlify.com/pricing?ref=authentication) incluyen todos los métodos de autenticación. @@ -21,50 +21,50 @@ Elige entre autenticación completa o parcial según tus necesidades de control **Autenticación completa**: Todas las páginas están protegidas. Los usuarios deben iniciar sesión antes de acceder a cualquier contenido. -**Autenticación parcial**: Algunas páginas son públicas mientras que otras requieren autenticación. Los usuarios pueden explorar libremente el contenido público y autenticarse solo al acceder a páginas protegidas. +**Autenticación parcial**: Algunas páginas son públicas, mientras que otras requieren autenticación. Los usuarios pueden explorar libremente el contenido público y autenticarse solo al acceder a páginas protegidas. -Al configurar cualquiera de los métodos de handshake a continuación, selecciona **Autenticación completa** o **Autenticación parcial** en la configuración del panel. +Al configurar cualquiera de los métodos de autenticación a continuación, deberás seleccionar **Autenticación completa** o **Autenticación parcial** en la configuración del panel.
## Configuración de la autenticación
-Selecciona el método de autenticación que quieres configurar. +Selecciona el método de handshake que quieres configurar. - + - La autenticación mediante contraseña solo ofrece control de acceso y **no** admite la personalización de contenido. + La autenticación con contraseña ofrece únicamente control de acceso y **no** admite la personalización de contenido. ### Requisitos previos - * Sus requisitos de seguridad permiten compartir contraseñas entre usuarios. + * Tus requisitos de seguridad permiten compartir contraseñas entre usuarios. ### Implementación - - 1. En su panel, vaya a [Authentication](https://dashboard.mintlify.com/settings/deployment/authentication). - 2. Seleccione **Full Authentication** o **Partial Authentication**. - 3. Seleccione **Password**. - 4. Ingrese una contraseña segura. - 5. Seleccione **Save changes**. + + 1. En tu panel, ve a [Authentication](https://dashboard.mintlify.com/settings/deployment/authentication). + 2. Selecciona **Full Authentication** o **Partial Authentication**. + 3. Selecciona **Password**. + 4. Introduce una contraseña segura. + 5. Selecciona **Save changes**. - - Comparta de forma segura la contraseña y la URL de la documentación con los usuarios autorizados. + + Comparte de forma segura la contraseña y la URL de la documentación con los usuarios autorizados. ## Ejemplo - Tu documentación está alojada en `docs.foo.com` y necesitas un control de acceso básico sin tener que rastrear a usuarios individuales. Quieres impedir el acceso público y mantener una configuración sencilla. + Tu documentación está alojada en `docs.foo.com` y necesitas un control de acceso básico sin rastrear a usuarios individuales. Quieres evitar el acceso público manteniendo una configuración simple. - **Crea una contraseña robusta** en tu panel. **Comparte las credenciales** con los usuarios autorizados. ¡Listo! + **Crea una contraseña segura** en tu panel. **Comparte las credenciales** con los usuarios autorizados. ¡Listo! - + ### Requisitos previos * Los usuarios de tu documentación también son quienes la editan. @@ -74,15 +74,15 @@ Selecciona el método de autenticación que quieres configurar. 1. En tu panel, ve a [Authentication](https://dashboard.mintlify.com/settings/deployment/authentication). - 2. Selecciona **Full Authentication** o **Partial Authentication**. + 2. Selecciona **Autenticación completa** o **Autenticación parcial**. 3. Selecciona **Mintlify Auth**. 4. Selecciona **Enable Mintlify Auth**. - + 1. En tu panel, ve a [Members](https://dashboard.mintlify.com/settings/organization/members). - 2. Agrega a cada persona que deba tener acceso a tu documentación. - 3. Asigna los roles correspondientes según sus permisos de edición. + 2. Añade a cada persona que deba tener acceso a tu documentación. + 3. Asigna los roles adecuados según sus permisos de edición. @@ -90,9 +90,9 @@ Selecciona el método de autenticación que quieres configurar. Tu documentación está alojada en `docs.foo.com` y tu equipo usa el panel para editarla. Quieres restringir el acceso solo a los miembros del equipo. - **Habilita la autenticación de Mintlify** en la configuración del panel. + **Habilita la autenticación de Mintlify** en la configuración de tu panel. - **Verifica el acceso del equipo** comprobando que todos los miembros estén agregados a tu organización. + **Verifica el acceso del equipo** comprobando que todos los miembros del equipo estén añadidos a tu organización. @@ -112,26 +112,26 @@ Selecciona el método de autenticación que quieres configurar. * **Authorization URL**: Tu endpoint de OAuth. * **Client ID**: Tu identificador de cliente de OAuth 2.0. * **Client Secret**: Tu secreto de cliente de OAuth 2.0. - * **Scopes**: Permisos a solicitar. Copia la cadena de scope **completa** (por ejemplo, para un scope como `provider.users.docs`, copia `provider.users.docs` completo). Usa varios scopes si necesitas diferentes niveles de acceso. + * **Scopes**: Permisos a solicitar. Copia la cadena de scope **completa** (por ejemplo, para un scope como `provider.users.docs`, copia el `provider.users.docs` completo). Usa varios scopes si necesitas diferentes niveles de acceso. * **Token URL**: Tu endpoint de intercambio de tokens de OAuth. * **Info API URL** (opcional): Endpoint para obtener la información del usuario para la personalización. Si se omite, el flujo de OAuth solo se usará para verificar la identidad y la información del usuario estará vacía. - * **Logout URL**: La URL de cierre de sesión nativa de tu proveedor de OAuth. Si tu proveedor tiene un parámetro `returnTo` o similar, haz que apunte de vuelta a la URL de tu documentación. + * **Logout URL**: La URL nativa de cierre de sesión de tu proveedor de OAuth. Si tu proveedor tiene un parámetro `returnTo` o similar, redirígelo de vuelta a la URL de tu documentación. 4. Selecciona **Save changes**. - 1. Copia la **Redirect URL** desde tu [authentication settings](https://dashboard.mintlify.com/settings/deployment/authentication). + 1. Copia la **Redirect URL** desde tu [configuración de autenticación](https://dashboard.mintlify.com/settings/deployment/authentication). 2. Agrega la URL de redirección como una URL de redirección autorizada en tu servidor OAuth. - Para habilitar las funciones de personalización, crea un endpoint de API que: + Para habilitar funciones de personalización, crea un endpoint de API que: * Acepte tokens de acceso de OAuth para la autenticación. - * Devuelva los datos del usuario en el formato `User`. Consulta [User data format](/es/authentication-personalization/personalization-setup#user-data-format) para más información. + * Devuelva datos de usuario en el formato `User`. Consulta [User data format](/es/authentication-personalization/personalization-setup#user-data-format) para obtener más información. - Agrega la URL de este endpoint al campo **Info API URL** en tu [authentication settings](https://dashboard.mintlify.com/settings/deployment/authentication). + Agrega la URL de este endpoint al campo **Info API URL** en tu [configuración de autenticación](https://dashboard.mintlify.com/settings/deployment/authentication). @@ -148,7 +148,7 @@ Selecciona el método de autenticación que quieres configurar. * **Info API URL**: `https://api.foo.com/docs/user-info` * **Logout URL**: `https://auth.foo.com/logout?returnTo=https%3A%2F%2Ffoo.com%2Fdocs` - **Crea un endpoint de información de usuario** en `api.foo.com/docs/user-info`, que requiera un token de acceso de OAuth con el scope `provider.users.docs`, y que devuelva: + **Crea un endpoint de información de usuario** en `api.foo.com/docs/user-info`, que requiere un token de acceso de OAuth con el scope `provider.users.docs`, y devuelve: ```json { @@ -160,7 +160,7 @@ Selecciona el método de autenticación que quieres configurar. } ``` - **Configura tu servidor OAuth para permitir redirecciones** a tu URL de callback. + **Configura tu servidor OAuth para permitir redirecciones** a tu URL de retorno. @@ -178,13 +178,13 @@ Selecciona el método de autenticación que quieres configurar. 3. Selecciona **JWT**. 4. Ingresa la URL de tu flujo de inicio de sesión existente y selecciona **Save changes**. 5. Selecciona **Generate new key**. - 6. Guarda tu clave de forma segura donde tu backend pueda acceder a ella. + 6. Almacena tu clave de forma segura donde tu backend pueda acceder a ella. Modifica tu flujo de inicio de sesión existente para incluir estos pasos después de autenticar al usuario: - * Crea un JWT que contenga la información del usuario autenticado en el formato `User`. Consulta [User data format](/es/authentication-personalization/personalization-setup#user-data-format) para obtener más información. + * Crea un JWT que contenga la información del usuario autenticado en el formato `User`. Consulta [User data format](/es/authentication-personalization/personalization-setup#user-data-format) para más información. * Firma el JWT con tu clave secreta usando el algoritmo EdDSA. * Crea una URL de redirección de vuelta a la ruta `/login/jwt-callback` de tu documentación, incluyendo el JWT como hash. @@ -192,9 +192,9 @@ Selecciona el método de autenticación que quieres configurar. ### Ejemplo - Tu documentación está alojada en `docs.foo.com` con un sistema de autenticación existente en `foo.com`. Quieres ampliar tu flujo de inicio de sesión para otorgar acceso a la documentación mientras mantienes la documentación separada de tu panel (o no tienes un panel). + Tu documentación está alojada en `docs.foo.com` con un sistema de autenticación existente en `foo.com`. Quieres ampliar tu flujo de inicio de sesión para otorgar acceso a la documentación manteniéndola separada de tu panel (o no tienes un panel). - Crea un endpoint de inicio de sesión en `https://foo.com/docs-login` que extienda tu autenticación existente. + Crea un endpoint de inicio de sesión en `https://foo.com/docs-login` que amplíe tu autenticación existente. Después de verificar las credenciales del usuario: @@ -212,7 +212,7 @@ Selecciona el método de autenticación que quieres configurar. export async function handleRequest(req: Request, res: Response) { const user = { - expiresAt: Math.floor((Date.now() + TWO_WEEKS_IN_MS) / 1000), // 2 week session expiration + expiresAt: Math.floor((Date.now() + TWO_WEEKS_IN_MS) / 1000), // vencimiento de sesión de 2 semanas groups: res.locals.user.groups, content: { firstName: res.locals.user.firstName, @@ -222,7 +222,7 @@ Selecciona el método de autenticación que quieres configurar. const jwt = await new jose.SignJWT(user) .setProtectedHeader({ alg: 'EdDSA' }) - .setExpirationTime('10 s') // 10 second JWT expiration + .setExpirationTime('10 s') // vencimiento del JWT de 10 segundos .sign(signingKey); return res.redirect(`https://docs.foo.com/login/jwt-callback#${jwt}`); @@ -242,8 +242,8 @@ Selecciona el método de autenticación que quieres configurar. async def return_mintlify_auth_status(current_user): jwt_token = jwt.encode( payload={ - 'exp': int((datetime.now() + timedelta(seconds=10)).timestamp()), # 10 second JWT expiration - 'expiresAt': int((datetime.now() + timedelta(weeks=2)).timestamp()), # 1 week session expiration + 'exp': int((datetime.now() + timedelta(seconds=10)).timestamp()), # vencimiento del JWT de 10 segundos + 'expiresAt': int((datetime.now() + timedelta(weeks=2)).timestamp()), # vencimiento de sesión de 1 semana 'groups': ['admin'] if current_user.is_admin else [], 'content': { 'firstName': current_user.first_name, @@ -258,32 +258,32 @@ Selecciona el método de autenticación que quieres configurar. ``` - ### Redirigir a usuarios no autenticados + ### Redirección de usuarios no autenticados Cuando un usuario no autenticado intenta acceder a una página protegida, su destino previsto se conserva en la redirección a tu URL de inicio de sesión: 1. El usuario intenta visitar una página protegida: `https://docs.foo.com/quickstart`. - 2. Se redirige a tu URL de inicio de sesión con un parámetro de consulta redirect: `https://foo.com/docs-login?redirect=%2Fquickstart`. + 2. Redirige a tu URL de inicio de sesión con un parámetro de consulta redirect: `https://foo.com/docs-login?redirect=%2Fquickstart`. 3. Después de la autenticación, redirige a `https://docs.foo.com/login/jwt-callback?redirect=%2Fquickstart#{SIGNED_JWT}`. 4. El usuario llega a su destino original.
- ## Hacer públicas las páginas + ## Hacer que las páginas sean públicas
-Cuando uses autenticación parcial, todas las páginas están protegidas de forma predeterminada. Puedes hacer que páginas específicas sean visibles sin autenticación, ya sea a nivel de página o de grupo, con la propiedad `public`. +Al usar la autenticación parcial, todas las páginas están protegidas de forma predeterminada. Puedes hacer que páginas específicas sean visibles sin autenticación, a nivel de página o de grupo, con la propiedad `public`.
### Nivel de página
-Para hacer una página pública, agrega `public: true` al frontmatter de la página. +Para hacer pública una página, agrega `public: true` al frontmatter de la página. -```mdx Public page example +```mdx Ejemplo de página pública --- -title: "Public page" +title: "Página pública" public: true --- ``` @@ -292,14 +292,14 @@ public: true ### Nivel de grupo -Para hacer públicas todas las páginas de un grupo, agrega `"public": true` debajo del nombre del grupo en el objeto `navigation` de tu `docs.json`. +Para que todas las páginas de un grupo sean públicas, agrega `"public": true` debajo del nombre del grupo en el objeto `navigation` de tu `docs.json`. -```json Public group example +```json Ejemplo de grupo público { "navigation": { "groups": [ { - "group": "Public group", + "group": "Grupo público", "public": true, "icon": "play", "pages": [ @@ -309,14 +309,14 @@ Para hacer públicas todas las páginas de un grupo, agrega `"public": true` deb ] }, { - "group": "Private group", + "group": "Grupo privado", "icon": "pause", "pages": [ - "private-information", - "secret-settings" + "informacion-privada", + "ajustes-secretos" ] } ] } } -``` \ No newline at end of file +``` diff --git a/es/authentication-personalization/overview.mdx b/es/authentication-personalization/overview.mdx index ffb624f1c..977cb5638 100644 --- a/es/authentication-personalization/overview.mdx +++ b/es/authentication-personalization/overview.mdx @@ -6,49 +6,49 @@ keywords: ["auth"] --- - [Los planes Pro](https://mintlify.com/pricing?ref=authentication) incluyen autenticación con contraseña. + Los [planes Pro](https://mintlify.com/pricing?ref=authentication) incluyen autenticación por contraseña. - [Los planes Enterprise](https://mintlify.com/pricing?ref=authentication) incluyen todos los métodos de autenticación. + Los [planes Enterprise](https://mintlify.com/pricing?ref=authentication) incluyen todos los métodos de autenticación. Elige entre tres enfoques para gestionar el acceso y personalizar tu documentación según la información del usuario y tus necesidades de seguridad: -* **Autenticación completa**: Protección total de la privacidad de todo el contenido con personalización completa. +* **Autenticación completa**: Protección total de la privacidad para todo el contenido con personalización completa. * **Autenticación parcial**: Control de acceso página por página con personalización completa. -* **Personalización**: Personalización del contenido sin garantías de seguridad. Todo el contenido permanece públicamente accesible. +* **Personalización**: Personalización del contenido **sin garantías de seguridad**. Todo el contenido permanece públicamente accesible.
- ### Ejemplos de casos de uso + ### Ejemplos de uso
**Elige autenticación completa cuando:** -* Crees documentación interna de la empresa que contenga información sensible -* Documentes APIs propietarias que requieran verificación del usuario +* Estés creando documentación interna de la empresa que contenga información sensible +* Documentes APIs propietarias que requieran verificación de usuario * Crees guías de implementación específicas para clientes **Elige autenticación parcial cuando:** -* Ofrezcas guías públicas de introducción con funciones avanzadas privadas +* Ofrezcas guías públicas de inicio con funciones avanzadas privadas * Administres un producto freemium donde los usuarios premium obtengan documentación adicional * Publiques documentación de código abierto con secciones empresariales privadas **Elige personalización cuando:** -* Crees documentación pública de API que muestre ejemplos específicos para el usuario -* Crees sitios de marketing que personalicen el contenido según los perfiles de usuario +* Crees documentación pública de API que muestre ejemplos específicos del usuario +* Construyas sitios de marketing que personalicen el contenido según los perfiles de usuario * Ofrezcas tutoriales públicos que se adapten a las preferencias o niveles de habilidad del usuario
## Métodos de autenticación
-Elige el método que mejor se adapte a tu infraestructura existente y a tus requisitos de seguridad. +Elige el método que mejor se adapte a tu infraestructura y a tus requisitos de seguridad. | Método | Disponible para | Complejidad de configuración | Ideal para | -|:-------|:--------------|:-----------------|:----------| +|:-------|:----------------|:-----------------------------|:-----------| | **JWT** | Todos los enfoques | Media | Flujos de inicio de sesión personalizados, máximo control de seguridad | -| **OAuth 2.0** | Todos los enfoques | Alta | Proveedores de autenticación de terceros, seguridad empresarial | +| **OAuth 2.0** | Todos los enfoques | Alta | Proveedores de autenticación de terceros, seguridad de nivel empresarial | | **Mintlify Dashboard** | Solo autenticación | Baja | Equipos que ya usan el panel de Mintlify | | **Password** | Solo autenticación | Baja | Acceso compartido simple sin personalización | | **Shared Session** | Solo personalización | Baja | Apps con autenticación basada en sesiones existente | @@ -57,13 +57,13 @@ Elige el método que mejor se adapte a tu infraestructura existente y a tus requ ### Cuándo usar cada método -**JWT**: Úsalo cuando ya tengas un sistema de autenticación y quieras control total sobre el flujo de inicio de sesión. Ideal para la gestión de usuarios personalizada o cuando necesitas desacoplar el acceso a la documentación de tu aplicación principal. +**JWT**: Úsalo cuando ya tengas un sistema de autenticación y quieras control total del flujo de inicio de sesión. Ideal para la gestión de usuarios personalizada o cuando necesites desacoplar el acceso a la documentación de tu aplicación principal. -**OAuth 2.0**: Úsalo cuando quieras aprovechar proveedores de autenticación de terceros (Google, GitHub, etc.) o necesites estándares de seguridad de nivel empresarial. Ideal para organizaciones que ya utilizan infraestructura OAuth. +**OAuth 2.0**: Úsalo cuando quieras aprovechar proveedores de autenticación de terceros (Google, GitHub, etc.) o necesites estándares de seguridad de nivel empresarial. Ideal para organizaciones que ya usan infraestructura OAuth. -**Mintlify Dashboard**: Úsalo cuando tus editores de documentación también sean tus lectores. Perfecto para equipos internos que ya gestionan el contenido mediante el panel de Mintlify. +**Mintlify Dashboard**: Úsalo cuando tus editores de documentación también sean los lectores. Perfecto para equipos internos que ya gestionan el contenido desde el panel de Mintlify. -**Password**: Úsalo para un control de acceso sencillo cuando no necesitas rastrear usuarios individuales ni personalizar contenido. Útil para contratistas, usuarios beta o accesos temporales. +**Password**: Úsalo para un control de acceso sencillo cuando no necesites rastrear usuarios individuales ni personalizar contenido. Útil para contratistas, usuarios beta o accesos temporales. **Shared Session**: Úsalo cuando quieras un inicio de sesión transparente entre tu aplicación y la documentación. Ideal cuando los usuarios ya están autenticados en tu aplicación principal y quieres personalizar su experiencia en la documentación. @@ -71,4 +71,4 @@ Elige el método que mejor se adapte a tu infraestructura existente y a tus requ ## Personalización de contenido -Los tres enfoques admiten funciones de personalización, como contenido MDX dinámico, prerelleno de claves de API y controles de visibilidad de páginas. Para obtener instrucciones de implementación detalladas, consulta la [configuración de Personalización](/es/authentication-personalization/personalization-setup). +Los tres enfoques admiten funciones de personalización, como contenido MDX dinámico, prellenado de claves de API y controles de visibilidad de páginas. Para obtener pautas de implementación detalladas, consulta la [Configuración de personalización](/es/authentication-personalization/personalization-setup). diff --git a/es/authentication-personalization/personalization-setup.mdx b/es/authentication-personalization/personalization-setup.mdx index c612e3eb9..a6dbe0ee1 100644 --- a/es/authentication-personalization/personalization-setup.mdx +++ b/es/authentication-personalization/personalization-setup.mdx @@ -1,10 +1,10 @@ --- -title: "Configuración de personalización" -description: "Permite que los usuarios inicien sesión para una experiencia de documentación personalizada" +title: "Configuración de Personalización" +description: "Permite que los usuarios inicien sesión para obtener experiencias de documentación personalizadas" icon: "user-cog" --- -La personalización adapta tu documentación para cada usuario cuando inicia sesión. Por ejemplo, puedes autocompletar sus claves de API, mostrar contenido específico para su plan o rol, u ocultar secciones a las que no necesitan acceder. +La Personalización adapta tu documentación a cada usuario cuando ha iniciado sesión. Por ejemplo, puedes completar previamente sus claves de API, mostrar contenido específico según su plan o rol, u ocultar secciones a las que no necesitan acceder. @@ -15,46 +15,45 @@ La personalización adapta tu documentación para cada usuario cuando inicia ses Personaliza el contenido con estas capacidades de personalización.
- ### Autorrelleno de claves de API + ### Autorrelleno de clave de API
-Completa automáticamente los campos del área de pruebas de API con valores específicos del usuario devolviendo nombres de campo que coincidan en tus datos de usuario. Para que el autorrelleno funcione, los nombres de los campos en tus datos de usuario deben coincidir exactamente con los nombres del área de pruebas de API. +Completa automáticamente los campos del Área de pruebas de API con valores específicos del usuario devolviendo nombres de campo que coincidan en tus datos de usuario. Los nombres de los campos en tus datos de usuario deben coincidir exactamente con los nombres del Área de pruebas de API para que el autorrelleno funcione.
### Contenido MDX dinámico
-Muestra contenido dinámico según información del usuario, como el nombre, el plan o la organización, usando la variable `user`. +Muestra contenido dinámico según información del usuario como el nombre, el plan u organización usando la variable `user`. ```jsx -Welcome back, {user.firstName}! Your {user.org?.plan} plan includes... +¡Bienvenido/a de nuevo, {user.firstName}! Tu plan {user.org?.plan} incluye... ``` -Consulta la sección [Formato de datos del usuario](#user-data-format) a continuación para ver ejemplos detallados y orientación de implementación. +Consulta la sección [Formato de datos de usuario](#user-data-format) más abajo para ver ejemplos detallados y orientación de implementación.
- ### Visibilidad de páginas + ### Visibilidad de la página
-Restringe qué páginas son visibles para tus usuarios agregando campos `groups` al frontmatter de tus páginas. De forma predeterminada, todas las páginas son visibles para todos los usuarios. +Restringe qué páginas son visibles para tus usuarios añadiendo campos `groups` al frontmatter de tus páginas. De forma predeterminada, cada página es visible para todos los usuarios. -Los usuarios solo verán las páginas de los `groups` a los que pertenecen. +Los usuarios solo verán las páginas de los `groups` a los que pertenezcan. ```mdx --- -title: "Managing your users" -description: "Adding and removing users from your organization" +title: "Gestión de tus usuarios" +description: "Añadir y eliminar usuarios de tu organización" groups: ["admin"] --- ``` -
## Formato de datos del usuario
-Al implementar la Personalización, tu sistema devuelve datos del usuario en un formato específico que habilita la personalización del contenido. Estos datos pueden enviarse como un objeto JSON en bruto o dentro de un JWT firmado, según tu método de intercambio (handshake). La estructura de los datos es la misma en ambos casos. +Al implementar la personalización, tu sistema devuelve los datos del usuario en un formato específico que permite personalizar el contenido. Estos datos pueden enviarse como un objeto JSON sin procesar o dentro de un JWT firmado, según tu método de intercambio. La estructura de los datos es la misma en ambos casos. ```tsx type User = { @@ -70,39 +69,36 @@ type User = { }; ``` - - Tiempo de expiración de la sesión en **segundos desde la época (epoch)**. Si el usuario carga una página después de este tiempo, sus datos almacenados se eliminan automáticamente y debe volver a autenticarse. - Para intercambios con JWT: Esto difiere del claim `exp` del JWT, que determina cuándo un JWT se considera inválido. Configura el claim `exp` del JWT con una duración corta (10 segundos o menos) por seguridad. Usa `expiresAt` para la duración real de la sesión (de horas a semanas). + + Tiempo de expiración de la sesión en **segundos desde el epoch**. Si el usuario carga una página después de este tiempo, sus datos almacenados se eliminan automáticamente y debe volver a autenticarse. + Para intercambios con JWT: Esto difiere del claim `exp` del JWT, que determina cuándo un JWT se considera inválido. Por seguridad, establece el claim `exp` del JWT en una duración corta (10 segundos o menos). Usa `expiresAt` para la duración real de la sesión (de horas a semanas). - + + Lista de grupos a los que pertenece el usuario. Las páginas con `groups` coincidentes en su frontmatter son visibles para este usuario. **Ejemplo**: Un usuario con `groups: ["admin", "engineering"]` puede acceder a páginas etiquetadas con los grupos `admin` o `engineering`. - - Datos personalizados accesibles en tu contenido `MDX` mediante la variable `user`. Úsalos para personalización dinámica en toda tu documentación. + + + Datos personalizados accesibles en tu contenido `MDX` mediante la variable `user`. Úsalo para la personalización dinámica en toda tu documentación. **Ejemplo básico**: + ```json { "firstName": "Ronan", "company": "Acme Corp", "plan": "Enterprise" } ``` **Uso en `MDX`**: + ```mdx Welcome back, {user.firstName}! Your {user.plan} plan includes... ``` + Con los datos de `user` del ejemplo, se renderizaría como: Welcome back, Ronan! Your Enterprise plan includes... **Renderizado condicional avanzado**: + ```jsx Authentication is an enterprise feature. { user.org === undefined @@ -114,16 +110,15 @@ type User = { ``` - La información en `user` solo está disponible para usuarios con sesión iniciada. Para usuarios cerrados, el valor de `user` será `{}`. Para evitar que la página falle para usuarios sin sesión, usa siempre encadenamiento opcional en los campos de `user`. Por ejemplo, `{user.org?.plan}`. + La información en `user` solo está disponible para usuarios autenticados. Para los usuarios que no han iniciado sesión, el valor de `user` será `{}`. Para evitar que la página falle con usuarios no autenticados, usa siempre encadenamiento opcional en los campos de `user`. Por ejemplo, `{user.org?.plan}`. - - Valores específicos del usuario que rellenan previamente los campos del Área de pruebas de API. Ahorra tiempo a los usuarios al autocompletar sus datos cuando prueban APIs. + + + Valores específicos del usuario que precargan los campos del Área de pruebas de API. Ahorra tiempo a los usuarios al autocompletar sus datos cuando prueban APIs. **Ejemplo**: + ```json { "header": { "X-API-Key": "user_api_key_123" }, @@ -131,13 +126,14 @@ type User = { "query": { "org_id": "12345" } } ``` - Si un usuario realiza solicitudes en un subdominio específico, puedes enviar `{ server: { subdomain: 'foo' } }` como un campo `apiPlaygroundInputs`. Este valor se rellenará previamente en cualquier página de API con el valor de `subdomain`. - Los campos `header`, `query` y `cookie` solo se rellenarán previamente si forman parte de tu [esquema de seguridad de OpenAPI](https://swagger.io/docs/specification/authentication/). Si un campo está en las secciones `Authorization` o `Server`, se rellenará previamente. Crear un parámetro de encabezado estándar llamado `Authorization` no habilitará esta función. + Si un usuario hace solicitudes en un subdominio específico, puedes enviar `{ server: { subdomain: 'foo' } }` como un campo `apiPlaygroundInputs`. Este valor se precargará en cualquier página de API con el valor `subdomain`. + + Los campos `header`, `query` y `cookie` solo se precargarán si forman parte de tu [esquema de seguridad de OpenAPI](https://swagger.io/docs/specification/authentication/). Si un campo está en las secciones `Authorization` o `Server`, se precargará. Crear un parámetro de encabezado estándar llamado `Authorization` no habilitará esta función.
- ### Ejemplo de datos de usuario + ### Datos de usuario de ejemplo
```json @@ -165,7 +161,6 @@ type User = { ``` -
## Configuración de la personalización
@@ -178,33 +173,33 @@ Selecciona el método de handshake que deseas configurar. ### Requisitos previos - * Un sistema de inicio de sesión que pueda generar y firmar JWT + * Un sistema de autenticación que pueda generar y firmar JWT * Un servicio de backend que pueda crear URL de redirección ### Implementación - + 1. En tu panel, ve a [Authentication](https://dashboard.mintlify.com/settings/deployment/authentication). 2. Selecciona **Personalization**. 3. Selecciona **JWT**. - 4. Ingresa la URL de tu flujo de inicio de sesión existente y selecciona **Save changes**. + 4. Introduce la URL de tu flujo de inicio de sesión existente y selecciona **Save changes**. 5. Selecciona **Generate new key**. - 6. Guarda tu clave de forma segura donde pueda accederla tu backend. + 6. Almacena tu clave de forma segura en un lugar al que tu backend pueda acceder. - + Modifica tu flujo de inicio de sesión existente para incluir estos pasos después de que el usuario inicie sesión: * Crea un JWT que contenga la información del usuario autenticado en el formato `User`. Consulta la sección [User data format](#user-data-format) más arriba para obtener más información. * Firma el JWT con la clave secreta usando el algoritmo ES256. - * Crea una URL de redirección de vuelta a tu documentación, incluyendo el JWT como hash. + * Crea una URL de redirección de regreso a tu documentación, incluyendo el JWT como hash. ### Ejemplo - Tu documentación está alojada en `docs.foo.com`. Quieres que tu documentación esté separada de tu panel (o no tienes un panel) y habilitar la Personalización. + Tu documentación está alojada en `docs.foo.com`. Quieres que tu documentación esté separada de tu panel (o no tienes un panel) y habilitar la personalización. Genera un secreto de JWT. Luego crea un endpoint de inicio de sesión en `https://foo.com/docs-login` que inicie un flujo de inicio de sesión hacia tu documentación. @@ -242,7 +237,7 @@ Selecciona el método de handshake que deseas configurar. ### Conservar anclas de página - Para redirigir a los usuarios a secciones específicas después del inicio de sesión, usa este formato de URL: `https://docs.foo.com/page#jwt={SIGNED_JWT}&anchor={ANCHOR}`. + Para redirigir a los usuarios a secciones específicas después de iniciar sesión, usa este formato de URL: `https://docs.foo.com/page#jwt={SIGNED_JWT}&anchor={ANCHOR}`. **Ejemplo**: @@ -253,7 +248,7 @@ Selecciona el método de handshake que deseas configurar. ### Requisitos previos - * Un servidor OAuth que admita el flujo de código de autorización (Auth Code) con PKCE + * Un servidor OAuth que sea compatible con el flujo de código de autorización con PKCE * Capacidad para crear un endpoint de API accesible mediante tokens de acceso de OAuth ### Implementación @@ -263,8 +258,8 @@ Selecciona el método de handshake que deseas configurar. Crea un endpoint de API que: * Acepte tokens de acceso de OAuth para la autenticación. - * Devuelva datos del usuario en el formato `User`. Consulta la sección [Formato de datos de usuario](#user-data-format) más arriba para obtener más información. - * Defina los scopes de acceso. + * Devuelva datos de usuario en el formato `User`. Consulta la sección [User data format](#user-data-format) más arriba para obtener más información. + * Defina los scopes (alcances) de acceso. @@ -276,7 +271,7 @@ Selecciona el método de handshake que deseas configurar. * **Client ID**: Tu identificador de cliente de OAuth 2.0. * **Scopes**: Permisos a solicitar. Copia la cadena de scope **completa** (por ejemplo, para un scope como `provider.users.docs`, copia el `provider.users.docs` completo). Debe coincidir con los scopes del endpoint que configuraste en el primer paso. * **Token URL**: Tu endpoint de intercambio de tokens de OAuth. - * **Info API URL**: Endpoint para obtener datos del usuario para la personalización. Creado en el primer paso. + * **Info API URL**: Endpoint para recuperar datos de usuario para la personalización. Creado en el primer paso. 4. Selecciona **Save changes** @@ -289,9 +284,9 @@ Selecciona el método de handshake que deseas configurar. ### Ejemplo - Tu documentación está alojada en `foo.com/docs` y tienes un servidor OAuth existente que admite el flujo PKCE. Quieres personalizar tu documentación según los datos del usuario. + Tu documentación está alojada en `foo.com/docs` y tienes un servidor OAuth existente que admite el flujo PKCE. Quieres personalizar tu documentación en función de los datos del usuario. - **Crea un endpoint de información de usuario** en `api.foo.com/docs/user-info`, que requiera un token de acceso de OAuth con el scope `provider.users.docs` y responda con los datos personalizados del usuario: + **Crea un endpoint de información de usuario** en `api.foo.com/docs/user-info`, que requiere un token de acceso de OAuth con el scope `provider.users.docs` y responde con los datos personalizados del usuario: ```json { @@ -299,57 +294,57 @@ Selecciona el método de handshake que deseas configurar. "firstName": "Jane", "lastName": "Doe" }, - "groups": ["engineering", "admin"] + "groups": ["ingeniería", "administración"] } ``` **Configura los detalles de tu servidor OAuth** en tu panel: - * **Authorization URL**: `https://auth.foo.com/authorization` - * **Client ID**: `ydybo4SD8PR73vzWWd6S0ObH` - * **Scopes**: `['docs-user-info']` - * **Token URL**: `https://auth.foo.com/exchange` - * **Info API URL**: `https://api.foo.com/docs/user-info` + * **URL de autorización**: `https://auth.foo.com/authorization` + * **ID de cliente**: `ydybo4SD8PR73vzWWd6S0ObH` + * **Ámbitos (scopes)**: `['docs-user-info']` + * **URL de token**: `https://auth.foo.com/exchange` + * **URL de la API de información**: `https://api.foo.com/docs/user-info` - **Configura tu servidor OAuth** para permitir redirecciones a tu URL de callback. + **Configura tu servidor OAuth** para permitir redirecciones a tu URL de retorno (callback). - + ### Requisitos previos * Un panel o portal de usuario con autenticación de sesión basada en cookies. - * Capacidad para crear un endpoint de API en el mismo origen o subdominio que tu panel. - * Si tu panel está en `foo.com`, la **URL de la API** debe comenzar con `foo.com` o `*.foo.com`. - * Si tu panel está en `dash.foo.com`, la **URL de la API** debe comenzar con `dash.foo.com` o `*.dash.foo.com`. - * Tu documentación está alojada en el mismo dominio o subdominio que tu panel. - * Si tu panel está en `foo.com`, tu **documentación** debe estar alojada en `foo.com` o `*.foo.com`. - * Si tu panel está en `*.foo.com`, tu **documentación** debe estar alojada en `foo.com` o `*.foo.com`. + * Capacidad para crear un endpoint de API en el mismo origen o subdominio que su panel. + * Si su panel está en `foo.com`, la **URL de la API** debe comenzar con `foo.com` o `*.foo.com`. + * Si su panel está en `dash.foo.com`, la **URL de la API** debe comenzar con `dash.foo.com` o `*.dash.foo.com`. + * Su documentación está alojada en el mismo dominio o subdominio que su panel. + * Si su panel está en `foo.com`, su **documentación** debe estar alojada en `foo.com` o `*.foo.com`. + * Si su panel está en `*.foo.com`, su **documentación** debe estar alojada en `foo.com` o `*.foo.com`. ### Implementación - - Crea un endpoint de API que: + + Cree un endpoint de API que: - * Use tu autenticación de sesión existente para identificar a los usuarios - * Devuelva datos de usuario en el formato `User` (consulta la sección [Formato de datos de usuario](#user-data-format) anterior) + * Use su autenticación de sesión existente para identificar a los usuarios + * Devuelva los datos del usuario en el formato `User` (consulte la sección [User data format](#user-data-format) arriba) * Si el dominio de la API y el dominio de la documentación **no coinciden exactamente**: - * Agrega el dominio de la documentación al encabezado `Access-Control-Allow-Origin` de tu API (no debe ser `*`). - * Establece el encabezado `Access-Control-Allow-Credentials` de tu API en `true`. + * Agregue el dominio de la documentación al encabezado `Access-Control-Allow-Origin` de su API (no debe ser `*`). + * Establezca el encabezado `Access-Control-Allow-Credentials` de su API en `true`. - Habilita los encabezados CORS solo en este endpoint específico, no en toda tu API del panel. + Habilite los encabezados CORS solo en este endpoint específico, no en toda la API de su panel. - - 1. En tu panel, ve a [Authentication](https://dashboard.mintlify.com/settings/deployment/authentication). - 2. Selecciona **Personalization**. - 3. Selecciona **Shared Session**. - 4. Ingresa tu **Info API URL**, que es el endpoint del primer paso. - 5. Ingresa tu **Login URL**, donde los usuarios inician sesión en tu panel. - 6. Selecciona **Save changes**. + + 1. En su panel, vaya a [Authentication](https://dashboard.mintlify.com/settings/deployment/authentication). + 2. Seleccione **Personalization**. + 3. Seleccione **Shared Session**. + 4. Ingrese su **Info API URL**, que es el endpoint del primer paso. + 5. Ingrese su **Login URL**, donde los usuarios inician sesión en su panel. + 6. Seleccione **Save changes**. @@ -357,36 +352,36 @@ Selecciona el método de handshake que deseas configurar. #### Panel en subdominio, documentación en subdominio - Tienes un panel en `dash.foo.com`, que utiliza autenticación de sesión basada en cookies. Las rutas de la API de tu panel están alojadas en `dash.foo.com/api`. Quieres configurar la personalización para tu documentación alojada en `docs.foo.com`. + Tiene un panel en `dash.foo.com`, que usa autenticación de sesión basada en cookies. Las rutas de la API de su panel están alojadas en `dash.foo.com/api`. Desea configurar la personalización para su documentación alojada en `docs.foo.com`. - Proceso de configuración: + **Proceso de configuración**: - 1. Crea el endpoint `dash.foo.com/api/docs/user-info` que identifique a los usuarios mediante autenticación de sesión y responda con sus datos de usuario. - 2. Agrega encabezados CORS solo para esta ruta: + 1. **Cree el endpoint** `dash.foo.com/api/docs/user-info` que identifique a los usuarios mediante la autenticación de sesión y responda con sus datos de usuario. + 2. **Agregue encabezados CORS** solo para esta ruta: * `Access-Control-Allow-Origin`: `https://docs.foo.com` * `Access-Control-Allow-Credentials`: `true` - 3. Configura la URL de la API en la configuración de autenticación: `https://dash.foo.com/api/docs/user-info`. + 3. **Configure la URL de la API** en la configuración de autenticación: `https://dash.foo.com/api/docs/user-info`. #### Panel en subdominio, documentación en raíz - Tienes un panel en `dash.foo.com`, que utiliza autenticación de sesión basada en cookies. Las rutas de la API de tu panel están alojadas en `dash.foo.com/api`. Quieres configurar la personalización para tu documentación alojada en `foo.com/docs`. + Tiene un panel en `dash.foo.com`, que usa autenticación de sesión basada en cookies. Las rutas de la API de su panel están alojadas en `dash.foo.com/api`. Desea configurar la personalización para su documentación alojada en `foo.com/docs`. - Proceso de configuración: + **Proceso de configuración**: - 1. Crea el endpoint `dash.foo.com/api/docs/user-info` que identifique a los usuarios mediante autenticación de sesión y responda con sus datos de usuario. - 2. Agrega encabezados CORS solo para esta ruta: + 1. **Cree el endpoint** `dash.foo.com/api/docs/user-info` que identifique a los usuarios mediante la autenticación de sesión y responda con sus datos de usuario. + 2. **Agregue encabezados CORS** solo para esta ruta: * `Access-Control-Allow-Origin`: `https://foo.com` * `Access-Control-Allow-Credentials`: `true` - 3. Configura la URL de la API en la configuración de autenticación: `https://dash.foo.com/api/docs/user-info`. + 3. **Configure la URL de la API** en la configuración de autenticación: `https://dash.foo.com/api/docs/user-info`. #### Panel en raíz, documentación en raíz - Tienes un panel en `foo.com/dashboard`, que utiliza autenticación de sesión basada en cookies. Las rutas de la API de tu panel están alojadas en `foo.com/api`. Quieres configurar la personalización para tu documentación alojada en `foo.com/docs`. + Tiene un panel en `foo.com/dashboard`, que usa autenticación de sesión basada en cookies. Las rutas de la API de su panel están alojadas en `foo.com/api`. Desea configurar la personalización para su documentación alojada en `foo.com/docs`. - Proceso de configuración: + **Proceso de configuración**: - 1. Crea el endpoint `foo.com/api/docs/user-info` que identifique a los usuarios mediante autenticación de sesión y responda con sus datos de usuario. - 2. Configura la URL de la API en la configuración de autenticación: `https://foo.com/api/docs/user-info` + 1. **Cree el endpoint** `foo.com/api/docs/user-info` que identifique a los usuarios mediante la autenticación de sesión y responda con sus datos de usuario. + 2. **Configure la URL de la API** en la configuración de autenticación: `https://foo.com/api/docs/user-info` No se necesita configuración de CORS, ya que el panel y la documentación comparten el mismo dominio. diff --git a/es/changelog.mdx b/es/changelog.mdx index 17bf5c513..313c125cc 100644 --- a/es/changelog.mdx +++ b/es/changelog.mdx @@ -1,295 +1,316 @@ --- -title: "Actualizaciones del producto" +title: "Actualizaciones de producto" description: "Nuevos lanzamientos y mejoras" rss: true noindex: true --- - - ## Lanzamientos principales + + ## Mejoras en la integración con GitLab - * **Mejora importante**: páginas sugeridas por IA en 404, [cuando alguien llega a un enlace roto → el agente de IA lee la ruta → sugiere páginas semánticamente similares](https://x.com/mintlify/status/1966625627773059495) - * **Lanzamiento importante**: la búsqueda web del asistente ahora puede incluir fuentes externas\ + * Se mejoró la interfaz de conexión a GitLab en la configuración del panel para facilitar la gestión de repositorios + * Se añadió compatibilidad con webhooks para actualizar automáticamente la documentación al hacer commits en GitLab + + ## Mejoras en el Editor web y la autenticación + + * Avances en la migración del app router para el Editor web, eliminando bloqueos y mejorando el rendimiento + * Mejor manejo de errores de inicio de sesión con mensajes explícitos de validación de correo electrónico + * Corrección del manejo de espacios en blanco en la validación de direcciones de correo + + ## Correcciones de errores y confiabilidad + + * Se corrigió la actualización de sockets del app router para funciones en tiempo real + * Se corrigieron problemas de renderizado de rutas SVG en la documentación + * Se corrigió la navegación por teclado en la búsqueda y el chat + * Se mejoró la confiabilidad del endpoint de estado del historial + * Se resolvieron casos límite de middleware y problemas con el manejo del evento onClick + + + + ## Lanzamientos importantes + + * **Mejora importante**: sugerencias de páginas por IA en páginas 404, [cuando alguien llega a un enlace roto → el agente de IA lee la ruta → sugiere páginas semánticamente similares](https://x.com/mintlify/status/1966625627773059495) + * **Lanzamiento importante**: la búsqueda web del Asistente ahora puede incluir fuentes externas\ *Nota: Contáctanos para habilitar esta función en tu sitio.* ## Asistente y MCP - * Se corrigió un error en el que el asistente era limitado por tasa de forma incorrecta porque la ventana de tiempo no se deslizaba correctamente - * Se corrigió un error en las llamadas a herramientas del asistente para manejar correctamente bloques `text` vacíos - * Se corrigió un error en el que los nombres del servidor MCP concatenados con llamadas a herramientas a veces excedían la longitud de 60 caracteres que imponen los clientes MCP - * Se corrigió un error en el que el menú del asistente tenía una altura varias veces mayor que el viewport y se desplazaba indefinidamente - * Se corrigió un error en el que los valores de gasto del asistente podían mostrarse con más de dos decimales en el panel + * Se corrigió un error por el cual al Asistente se le aplicaba rate limiting de forma incorrecta debido a que la ventana de tiempo no se deslizaba bien + * Se corrigió un error en las llamadas a herramientas del Asistente para manejar correctamente bloques `text` vacíos + * Se corrigió un error donde los nombres de servidor de MCP concatenados con llamadas a herramientas a veces excedían los 60 caracteres que imponen los clientes MCP + * Se corrigió un error donde el menú del Asistente tenía una altura varias veces mayor que el viewport y hacía scroll infinito + * Se corrigió un error donde los valores de gasto del Asistente podían mostrarse con más de dos decimales en el panel ## Editor web y despliegues - * Mejora de seguridad en el editor para que solo los usuarios con `write permissions` en el repositorio de alojamiento Git conectado puedan hacer cambios - * Se corrigió un error por el que los despliegues de vista previa no funcionaban para ramas con `=` en el nombre - * Se corrigió un error por el que los nombres de rama largos se desbordaban en los modales al crear despliegues de vista previa - * Mejora de usabilidad: el parámetro de consulta email rellenará previamente el campo en invitaciones de registro - * Se corrigió un error por el que copiar una página desde el menú contextual no funcionaba en Safari + * Mejora de seguridad en el editor: solo los usuarios con `write permissions` en el repositorio de Git conectado pueden realizar cambios + * Se corrigió un error donde los despliegues de vista previa no funcionaban para ramas con `=` en el nombre + * Se corrigió un error donde los nombres de ramas largos se desbordaban en los modales al crear despliegues de vista previa + * Mejora de usabilidad: el parámetro de consulta de correo electrónico rellenará previamente el campo en invitaciones de registro + * Se corrigió un error donde copiar una página desde el menú contextual no funcionaba en Safari ## Área de pruebas de API y navegación - * Múltiples códigos de respuesta del área de pruebas de API ahora se muestran en un menú select con estilo controlado en lugar del select predeterminado del sistema cuando tiene el foco + * Los múltiples códigos de respuesta del Área de pruebas de API ahora se muestran en un menú select con estilo controlado en lugar del select predeterminado del sistema al enfocarlo * Ahora puedes usar el [campo `expanded` en los grupos de navegación de tu `docs.json` para que se abran por defecto](https://mintlify.com/docs/navigation#default-expanded-state) ## SEO y UI - * Se corrigió un error por el que los favicons no aparecían en los motores de búsqueda sirviéndolos desde la misma URL que el propio sitio de documentación para cada sitio - * Se corrigió un error por el que las incrustaciones de YouTube parpadeaban al cargar - * Se corrigió un error por el que expandir el menú de comentarios para incluir respuestas escritas causaba un cambio de diseño en la tabla de contenido - * Se corrigió un error por el que el texto se desbordaba por encima de la barra superior en el tema Maple al descartar la barra de notificaciones - * Se mejoraron los temas Maple y Willow añadiendo botones de inicio/cierre de sesión en la barra lateral para facilitar el acceso + * Se corrigió un error por el cual los favicons no aparecían en los motores de búsqueda al servirlos desde la misma URL que el sitio de documentación de cada sitio + * Se corrigió un error donde los embeds de YouTube parpadeaban al cargar + * Se corrigió un error donde expandir el menú de feedback para incluir respuestas escritas causaba cambios de diseño en la tabla de contenidos + * Se corrigió un error donde el texto se superponía a la barra superior en el tema Maple al descartar la barra de notificación + * Se mejoraron los temas Maple y Willow añadiendo botones de iniciar/cerrar sesión en la barra lateral para facilitar el acceso - ## Analítica y exportaciones + ## Analíticas y exportaciones - * Se corrigieron problemas de confiabilidad en la vista y las exportaciones de la analítica del asistente - * Las exportaciones de la analítica del asistente ahora se ejecutan en segundo plano y se envían por correo electrónico para una experiencia más confiable + * Se corrigieron problemas de confiabilidad en la vista de analíticas del Asistente y en las exportaciones + * Las exportaciones de analíticas del Asistente ahora se ejecutan en segundo plano y se envían por correo electrónico para una experiencia más confiable - - ## Lanzamiento principal: recopilación de comentarios mejorada + + ## Lanzamiento principal: recopilación de feedback mejorada - * **Mejora importante**: Los lectores ahora pueden dar comentarios más detallados después de seleccionar *pulgar arriba/abajo*, incluyendo opciones y comentarios escritos. También puedes recopilar comentarios en bloques de código y ver todas las respuestas en las analíticas de tu panel.\ + * **Mejora importante**: Ahora los lectores pueden dar feedback más detallado después de seleccionar *pulgar arriba/abajo*, incluyendo opciones y comentarios escritos. También puedes recopilar feedback en bloques de código y ver todas las respuestas en las analíticas de tu panel.\ *Nota: Contáctanos para habilitar esta función en tu sitio.* - ## Mejoras de navegación y de experiencia + ## Mejoras de navegación y de usabilidad - * Mejora de experiencia para ignorar barras finales y dobles barras, de modo que no tengas que preocuparte por colocarlas exactamente en tu docs.json + * Mejora de usabilidad para ignorar las barras finales y dobles, para que no tengas que preocuparte por colocarlas exactamente bien en tu docs.json * Ahora puedes agregar el atributo `noAnchor` a tus etiquetas HTML `h1-6` para evitar que tengan un enlace de ancla - * El tema Palm ahora incluye un selector de idioma flotante en la esquina inferior izquierda, similar al enfoque de Stripe - * Se agregó un nuevo campo al docs.json llamado [`drilldown`](https://mintlify.com/docs/navigation#enable-auto-navigation-for-groups) que te permite controlar si los usuarios son dirigidos o no a la primera página de un grupo de navegación cuando el grupo se expande - * Mejora de experiencia para hacer que las listas ordenadas anidadas alternen estilos de decimal/romano a alfabético + * El tema Palm ahora tiene un selector de idioma flotante en la esquina inferior izquierda, similar al enfoque de Stripe + * Se agregó un nuevo campo a docs.json llamado [`drilldown`](https://mintlify.com/docs/navigation#enable-auto-navigation-for-groups) que te permite controlar si los usuarios son dirigidos o no a la primera página de un grupo de navegación cuando el grupo se expande + * Mejora de usabilidad para que las listas ordenadas anidadas alternen estilos de decimal/romano a alfabético ## Correcciones de errores y confiabilidad - * Se corrigió un error en el que los enlaces de ancla de posición de desplazamiento no funcionaban correctamente cuando había componentes JS en una página - * Se corrigió un error por el que Google estaba indexando archivos `*.md` sin procesar porque faltaba el encabezado `x-robots-tag: noindex` - * Se corrigió un error con OAuth en documentos protegidos que impedía redirigirte a tu página inicial una vez completado correctamente el flujo - * Se corrigió un error en las vistas previas de documentos protegidos por autenticación que impedía ver toda la barra de navegación - * Correcciones en el manejo de SVG con nuestra nueva CDN de imágenes + * Se corrigió un error por el que los enlaces de ancla de posición de desplazamiento no funcionaban correctamente cuando había componentes JS en una página + * Se corrigió un error por el que Google estaba indexando archivos `*.md` en bruto porque les faltaba el encabezado `x-robots-tag: noindex` + * Se corrigió un error con OAuth en documentos protegidos por el que no te redirigía a tu página inicial tras completar correctamente el flujo + * Se corrigió un error en las vistas previas de documentos protegidos por autenticación por el que no podías ver toda la barra de navegación + * Correcciones en cómo se manejan los SVG con nuestra nueva CDN de imágenes - ## Mejoras de componentes y estilo + ## Mejoras de componentes y estilos - * Se agregó un nuevo selector CSS para estilos personalizados en `SidebarNavGroupDivider` - * Nuevas pruebas de regresión para páginas de API definidas en MDX con seguridad definida garantizarán un mayor grado de estabilidad + * Se añadió un nuevo selector CSS para estilos personalizados en `SidebarNavGroupDivider` + * Nuevas pruebas de regresión para páginas de API definidas en MDX que tienen seguridad definida garantizarán un mayor grado de estabilidad ## Mejoras de rendimiento * Mejora de rendimiento al mover el CSS de KaTeX de cdnjs a nuestra propia CDN en CloudFront para reducir la latencia - + ## Mejoras en el manejo de imágenes - * **Mejora importante**: Las imágenes ya no causan desplazamientos de diseño por defecto, incluso cuando no se especifican los atributos de ancho y alto; el dimensionamiento automático evita saltos de contenido durante la carga de la página - * Todos los archivos estáticos de tu repositorio (PDF, TXT, XML, etc.) ahora se cargan y sirven automáticamente al publicar, proporcionando cobertura completa de recursos + * **Mejora importante**: Las imágenes ya no causan cambios de diseño por defecto, incluso cuando no se especifican los atributos de ancho y alto; el dimensionamiento automático evita saltos de contenido durante la carga de páginas + * Todos los archivos estáticos en tu repositorio (PDF, TXT, XML, etc.) ahora se suben y sirven automáticamente al desplegar, proporcionando cobertura completa de recursos ## Mejoras del editor web y del despliegue - * Se corrigió el flujo de creación de ramas en el Editor web para navegar correctamente a las nuevas ramas creadas y permanecer en ellas - * Se mejoró el diálogo de conflictos de fusión con una función de escape adecuada; ya no se requieren recargas de página para descartarlos - * Se optimizó el rendimiento del flujo de actualización invalidando la caché solo de las páginas modificadas durante actualizaciones parciales, reduciendo los tiempos de despliegue + * Se corrigió el flujo de creación de ramas en el editor web para navegar correctamente a las nuevas ramas y permanecer en ellas + * Diálogo de resolución de conflictos de fusión mejorado con funcionalidad de escape adecuada; ya no se requieren recargas de página para descartarlos + * Flujo de actualización optimizado al invalidar la caché solo de las páginas modificadas durante actualizaciones parciales, reduciendo los tiempos de despliegue ## Mejoras de autenticación y navegación * Nuevo soporte para autenticación en subdirectorios personalizados; si sirves la documentación en `https://yourdomain.com/docs`, la autenticación ahora funciona sin problemas - * Se corrigió un error de visualización en la barra lateral que aparecía cuando solo había un enlace configurado - * Renovación integral de la navegación móvil: botones centrados con margen y relleno adecuados, mejor espaciado en menús desplegables, se eliminaron divisores y márgenes innecesarios en secciones vacías, y se corrigieron problemas de separación/espaciado en el tema Maple + * Se corrigió un error de visualización en la barra lateral que aparecía incorrectamente cuando solo se configuraba un enlace + * Renovación integral de la navegación móvil: botones centrados con margen/espaciado adecuados, mejor espaciado en menús desplegables, eliminación de divisores y márgenes innecesarios para secciones vacías, y corrección de problemas de huecos/relleno en el tema Maple - ## Correcciones de componentes y estilo + ## Correcciones de componentes y estilos - * Se resolvió un problema de conversión de etiquetas `` que las transformaba incorrectamente en componentes Heading y afectaba el estilo personalizado - * Se agregó un interruptor de configuración de un clic para el Asistente en el panel para facilitar la gestión + * Se resolvió el problema de conversión de etiquetas `` que las transformaba incorrectamente en componentes Heading y alteraba los estilos personalizados + * Se añadió un interruptor de configuración de un clic para el Asistente en el panel para una gestión más sencilla ## Mejoras técnicas y confiabilidad - * Sistema de registro mejorado para los flujos de actualización, permitiendo una depuración más rápida y una resolución de problemas más eficiente - * Se solucionó la limitación de velocidad de GitHub para clientes con más de 10 especificaciones OpenAPI/AsyncAPI al pasar de la obtención de archivos individuales al clonado del repositorio - * Se mejoró la confiabilidad del Asistente con soporte de LLM de respaldo, mejor manejo de errores por límites de velocidad y una herramienta de búsqueda más robusta + * Sistema de registro mejorado para flujos de actualización que permite una depuración y resolución de problemas más rápidas + * Se corrigió la limitación de tasa de GitHub para clientes con más de 10 especificaciones de OpenAPI/AsyncAPI pasando de la obtención de archivos individuales al clonado del repositorio + * Mayor confiabilidad del Asistente con soporte de LLM de respaldo, mejor manejo de errores por límite de tasa y una herramienta de búsqueda más robusta - + ## Optimizaciones de rendimiento y compilación - * La transpilación de MDX ahora ocurre en el momento del despliegue en lugar de en cada carga de página en entornos serverless de NextJS sin caché, mejorando el tiempo hasta el primer byte en páginas no cacheadas. - * El hashing basado en contenido evita la retranspilación cuando el MDX no ha cambiado, reduciendo los tiempos del flujo de actualización en ~50% para clientes con un gran número de páginas (los despliegues de más de 5 minutos deberían reducirse aproximadamente a la mitad). - * La visualización de despliegues de vista previa en el panel ahora es más rápida gracias a índices adicionales en la base de datos y paralelización de consultas en nuestro backend. - * Se redujo el tamaño de página eliminando datos `navigation` duplicados en la carga útil `rsc` de cada página; las mejoras de rendimiento son más notorias con un alto número de páginas o estructuras de navegación complejas. - * Un prefetching más agresivo permite cargas instantáneas de página con mayor frecuencia. + * La transpilación de MDX ahora ocurre en el momento del despliegue en lugar de en cada carga de página en entornos serverless de Next.js sin caché, mejorando el time to first byte para páginas no cacheadas. + * El hashing basado en contenido evita la retranspilación cuando MDX no ha cambiado, reduciendo los tiempos del flujo de actualización en ~50% para clientes con muchas páginas (los despliegues de más de 5 minutos deberían reducirse aproximadamente a la mitad) + * Ver las vistas previas de despliegue en el panel ahora es más rápido gracias a índices de base de datos y paralelización de consultas en nuestro backend + * Se redujo el tamaño de página eliminando datos duplicados de `navigation` en la carga `rsc` de cada página; las mejoras de rendimiento son más notorias con muchos documentos o estructuras de navegación complejas + * Un prefetching más agresivo habilita cargas instantáneas de página con mayor frecuencia - ## Mejoras al área de pruebas de API y OpenAPI + ## Mejoras del área de pruebas de API y OpenAPI - * La conversión de OpenAPI a MCP se movió al backend, lo que permite que los servidores MCP alojados incluyan herramientas (pronto habrá documentación y opciones de configuración más claras). - * Se añadió compatibilidad con Ruby al área de pruebas de API. - * Agregamos una función con la que ahora puedes [especificar páginas de API usando solo tu docs.json](/es/api-playground/openapi-setup#auto-populate-api-pages) sin crear nuevos archivos MDX. - * Compatibilidad con páginas de [`webhook`](/es/api-playground/openapi-setup#webhooks) en la navegación de la documentación a partir de especificaciones OpenAPI. - * Se optimizó el contexto del modelo de IA eliminando los anclajes de los enlaces de Markdown al navegar a Anthropic, OpenAI u otros proveedores. + * La conversión de OpenAPI a MCP se movió al backend, lo que permite que los servidores MCP alojados incluyan herramientas (pronto habrá documentación y opciones de configuración más claras) + * Se añadió compatibilidad con Ruby en el área de pruebas de API + * Agregamos una función para que ahora puedas [especificar páginas de API usando solo tu docs.json](/es/api-playground/openapi-setup#auto-populate-api-pages) sin crear nuevos archivos MDX. + * Compatibilidad con páginas de [`webhook`](/es/api-playground/openapi-setup#webhooks) en la navegación de la documentación a partir de especificaciones OpenAPI + * Contexto del modelo de IA optimizado al eliminar especificaciones de enlaces de ancla de los enlaces de Markdown al navegar a Anthropic, OpenAI u otros proveedores ## Mejoras del editor web - * La creación y el cambio de nombre de archivos ahora guardan los cambios al hacer clic fuera, en lugar de requerir presionar la tecla Enter. - * Se corrigió la navegación entre ramas donde cambiar la URL a una rama específica redirigía a la última rama activa en lugar del destino previsto. - * Se codifican correctamente en la URL los títulos de ramas que contienen `/` para evitar fallos de navegación. - * Se corrigió el atajo de enlace `Ctrl+K` en el Editor del panel de monorepo, que estaba anteponiendo la ruta del repositorio de docs y creando enlaces rotos. + * La creación y el cambio de nombre de archivos ahora guardan los cambios al hacer clic fuera, en lugar de requerir presionar Enter + * Se corrigió la navegación de ramas en la que cambiar la URL a una rama específica redirigía a la última rama activa en lugar del destino previsto + * Codificación adecuada en la URL de títulos de ramas que contienen `/` para evitar errores de navegación + * Se corrigió el atajo `Ctrl+K` para enlaces en el Editor del panel de monorepo, que estaba anteponiendo la ruta del repositorio de docs y creando enlaces rotos ## Analítica e integraciones con LLM - * Compatibilidad con `llms.txt` y `llms-full.txt` personalizados: añádelos a la raíz del repositorio de docs para servirlos en los endpoints `/llms.txt` y `/llms-full.txt` para personalización de LLM. - * Se añadió la [integración de analítica de Hightouch](/es/integrations/analytics/hightouch#hightouch). - * Seguimiento de analítica del menú contextual mejorado (la visualización en el panel llegará pronto). - * Se añadieron pruebas de extremo a extremo (e2e) para `llms.txt` y `llms-full.txt` para garantizar una entrega correcta. + * Compatibilidad con `llms.txt` y `llms-full.txt` personalizados: añádelos a la raíz del repositorio de docs para servirlos en los endpoints `/llms.txt` y `/llms-full.txt` para personalización de LLM + * Se añadió la [integración de analítica de Hightouch](/es/integrations/analytics/hightouch#hightouch) + * Seguimiento de analítica del menú contextual mejorado (visualización en el panel próximamente) + * Se agregaron pruebas de extremo a extremo para `llms.txt` y `llms-full.txt` para garantizar su correcta entrega ## Mejoras de componentes y estilos - * Compatibilidad con nombres de clase personalizados en etiquetas `h{1-4}` para aplicar estilos de encabezado personalizados. - * Se corrigió el renderizado de etiquetas `h{1-4}` como componentes `Heading` con chips en modo de página personalizada. - * Se añadieron selectores CSS a las [migas de pan](/es/navigation#breadcrumbs) para aplicar CSS personalizado. - * Se corrigieron imágenes de Open Graph estiradas analizando dimensiones para mantener las proporciones a 56 px de altura. - * Se corrigió `VSCode` a `VS Code` en el menú contextual cuando está habilitado. - * Se corrigió que los encabezados dentro de componentes personalizados aparecieran en la tabla de contenidos junto con encabezados semánticos. + * Compatibilidad con nombres de clase personalizados en etiquetas `h{1-4}` para aplicar estilos de encabezado personalizados + * Se corrigió el renderizado de etiquetas `h{1-4}` como componentes `Heading` con chips en modo de página personalizada + * Se añadieron selectores CSS a las [breadcrumbs](/es/navigation#breadcrumbs) para objetivos de CSS personalizados + * Se corrigieron imágenes de open graph estiradas analizando dimensiones para mantener proporciones a 56 px de altura + * Se corrigió `VSCode` a `VS Code` en el menú contextual cuando está habilitado + * Se corrigió que los encabezados dentro de componentes personalizados aparecieran en la tabla de contenido junto con encabezados semánticos ## Correcciones de errores y confiabilidad - * Se corrigieron problemas de renderizado de PDF con ciertos títulos de página saneando caracteres que causaban problemas de generación. - * Se resolvió el error de la CLI `Cannot convert undefined or null to object` al encontrar archivos JSON de OpenAPI vacíos. - * Se corrigió que las metatags de Open Graph personalizadas en `docs.json` fueran sobrescritas por las generadas. - * Se corrigieron los clics del botón de RSS al aterrizar en enlaces de anclaje usando origin + pathname para los enlaces RSS. - * Se mejoró la velocidad de descarga de la CLI eliminando sourcemaps. + * Se corrigieron problemas de renderizado de PDF con ciertos títulos de página sanitizando caracteres que causaban problemas de generación + * Se resolvió el error de la CLI `Cannot convert undefined or null to object` al encontrar archivos JSON de OpenAPI vacíos + * Se corrigió que las metatags de open graph personalizadas en `docs.json` fueran sobrescritas por las generadas + * Se corrigieron los clics del botón de RSS al aterrizar en enlaces de ancla usando origin + pathname para los enlaces de RSS + * Se mejoró la velocidad de descarga de la CLI al eliminar sourcemaps ## Mejoras técnicas - * Se añadieron pruebas visuales al pipeline de CI para detectar regresiones más temprano. - * Capacidades mejoradas de manejo de errores y depuración. - * Cobertura de pruebas integral para nuevas funciones y casos límite. + * Se añadieron pruebas visuales al pipeline de CI para detección temprana de regresiones + * Capacidades mejoradas de manejo de errores y depuración + * Cobertura de pruebas integral para nuevas funciones y casos límite - + ## Mejoras de autenticación - * Acceso público a nivel de grupo: haz públicos grupos de páginas completos mediante `docs.json` para no tener que añadir `public: true` en cada página ([más información](https://mintlify.com/docs/authentication-personalization/authentication-setup#group-level)) - * Compatibilidad con [`logoutURL` en la configuración de OAuth](https://mintlify.com/docs/authentication-personalization/authentication-setup#implementation-3) para eliminar cookies de origen y completar el cierre de sesión - * En caso de errores de OAuth, los usuarios se redirigen a la `logoutURL` especificada para reiniciar el flujo de autenticación + * Acceso público a nivel de grupo: haz públicos grupos completos de páginas mediante `docs.json` para no tener que usar `public: true` en cada página ([más información](https://mintlify.com/docs/authentication-personalization/authentication-setup#group-level)) + * Compatibilidad con [`logoutURL` en la configuración de OAuth](https://mintlify.com/docs/authentication-personalization/authentication-setup#implementation-3) para eliminar cookies ascendentes y completar el cierre de sesión + * En errores de OAuth, los usuarios se redirigen a la `logoutURL` especificada para reiniciar el flujo de autenticación * Corregido un parpadeo de error 500 durante los flujos de OAuth/JWT antes del callback - * Eliminación automática de `https://` de las URL en la configuración de autenticación OAuth/JWT para prevenir configuraciones incorrectas + * Eliminación automática de `https://` de las URL en la configuración de autenticación OAuth/JWT para evitar errores de configuración ## Mejoras del Área de pruebas de API * Nuevo [endpoint de la Search API](https://mintlify.com/docs/api-reference/assistant/search) para que puedas crear agentes y servidores MCP sobre tu documentación - * Los archivos `openapi` y `asyncapi` ahora se sirven en sus rutas especificadas (p. ej., `https://mydocsurl.extension/{openapi-or-file-name}.json`) - * Ahora puedes usar el [campo `x-mint` en tus archivos OpenAPI](https://mintlify.com/docs/api-playground/openapi-setup#x-mint-extension) para anular campos generados, personalizar el contenido del prefacio o cambiar las URL de endpoints en ejemplos de código + * Los archivos `openapi` y `asyncapi` ahora se sirven en sus rutas especificadas (por ejemplo, `https://mydocsurl.extension/{openapi-or-file-name}.json`) + * Ahora puedes usar el [campo `x-mint` en tus archivos OpenAPI](https://mintlify.com/docs/api-playground/openapi-setup#x-mint-extension) para anular campos generados, personalizar el contenido de introducción o cambiar las URL de endpoints en ejemplos de código * [`x-mcp` ahora es `x-mint.mcp`](https://mintlify.com/docs/api-playground/openapi-setup#mcp) en configuraciones de OpenAPI para controlar qué rutas se exponen como herramientas MCP ## Actualizaciones del Asistente - * Se corrigió un problema por el que el menú de acciones (con opciones como copiar y pulgar arriba) de mensajes antiguos desaparecía cuando llegaban nuevos por streaming - * Se corrigió la accesibilidad de las páginas anidadas `/mcp/...` tras el [lanzamiento de los servidores MCP alojados](https://mintlify.com/docs/ai/model-context-protocol#accessing-your-mcp-server) de la semana pasada + * Se corrigió un problema en el que el menú de acciones (con opciones como copiar y pulgar arriba) de mensajes antiguos desaparecía cuando llegaban nuevos mensajes en streaming + * Se corrigió la accesibilidad de páginas anidadas `/mcp/...` tras el [lanzamiento de servidores MCP alojados](https://mintlify.com/docs/ai/model-context-protocol#accessing-your-mcp-server) de la semana pasada ## Rendimiento y confiabilidad - * Todos los recursos de imagen y video presentes en tu repositorio de documentación ahora se sirven en la ruta correspondiente de tu dominio. Por ejemplo, si tienes `/assets/marketing/my-logo.png` en tu repo, estará disponible en `https://mydocsurl.extension/assets/marketing/my-logo.png`. - * El campo de correo electrónico en el inicio de sesión del panel de Mintlify ahora tiene enfoque automático para que puedas empezar a escribir de inmediato (mejora de usabilidad) + * Todos los recursos de imagen y video presentes en tu repo de docs ahora se sirven en la ruta adecuada en tu dominio. Por ejemplo, si tienes `/assets/marketing/my-logo.png` en tu repo, estará disponible en `https://mydocsurl.extension/assets/marketing/my-logo.png`. + * El campo de correo electrónico en el inicio de sesión del panel de Mintlify ahora enfoca automáticamente para que puedas empezar a escribir de inmediato *(mejora de calidad de vida)* * Tanto dominios personalizados como subdominios en Redis para mejorar el rendimiento en los tiempos de carga de la navegación (~50 ms menos de latencia) - * Se agregó lógica de reintento para las exportaciones a PDF y mejorar la confiabilidad - * Se corrigió que el aviso de consentimiento de cookies reapareciera después de aceptar o descartar: ahora se respeta la primera selección - * Se corrigió la copia de una página al portapapeles en Safari especificando un tipo MIME en `navigator.write` + * Se agregó lógica de reintentos para exportaciones a PDF y mejorar la confiabilidad + * Se corrigió que el aviso de consentimiento de cookies reapareciera después de aceptar o descartar—ahora se respeta la primera selección + * Se corrigió copiar una página al portapapeles en Safari especificando un `type` MIME en `navigator.write` ## Mejoras técnicas - * Correcciones de errores del CLI para Windows y pnpm, además de pruebas de CI para prevenir regresiones - * Salida de registro de errores mejorada: una mejora de usabilidad para nuestro equipo de ingeniería al depurar - * Correcciones menores en la acción de CI de enlaces rotos cuando faltan archivos de `contentDirectory` + * Correcciones de la CLI para Windows y pnpm, además de pruebas de CI para prevenir regresiones + * Salida de registro de errores mejorada—una mejora de calidad de vida para nuestro equipo de ingeniería al depurar + * Correcciones menores a la acción de CI de enlaces rotos cuando faltan archivos de `contentDirectory` * Se corrigió una regresión causada por las correcciones de la vista previa protegida por autenticación de la semana pasada, donde la pestaña activa no se establecía correctamente en la UI de navegación - * Se corrigió que el color de fondo del tema claro no se aplicara a los íconos de la pestaña activa - * Se corrigió un problema por el que cambiar el tipo de autenticación en el panel se actualizaba y luego volvía al tipo guardado previamente: ahora la nueva selección persiste tras guardar - * Mejoras internas de DX para clientes enterprise con bibliotecas de UI personalizadas: ahora nos resulta más fácil incluir tus componentes y atender solicitudes en plazos más cortos + * Se corrigió que el color de fondo claro del tema no se aplicara a los íconos de la pestaña activa + * Se corrigió un problema en el que cambiar el tipo de autenticación en el panel se actualizaba y luego volvía al tipo guardado anteriormente—ahora la nueva selección persiste después de guardar + * Mejoras internas de DX para clientes empresariales con bibliotecas de UI personalizadas—ahora nos resulta más fácil incluir tus componentes y atender solicitudes en plazos más cortos - ## Mejoras en la autenticación + ## Mejoras de autenticación - * Mejoras en el desarrollo local de la autenticación, permitiendo desarrollar funciones y corregir errores más rápido en esta área del producto - * Despliegues de vista previa ahora disponibles para sitios protegidos por autenticación + * Mejoras en el desarrollo local de autenticación, lo que permite desarrollar más rápido funciones de autenticación y corregir errores en esta área del producto + * Implementaciones de vista previa ahora disponibles para sitios protegidos por autenticación * Se corrigió el comportamiento de redirección para devolver correctamente a los usuarios a su página original después de autenticarse - * Se corrigió la visualización del botón de cerrar sesión para la autenticación completa (antes solo funcionaba con autenticación parcial) + * Se corrigió la visualización del botón de cerrar sesión para autenticación completa (antes solo funcionaba con autenticación parcial) ## Mejoras del área de pruebas de API * Se corrigió la carga de archivos `multipart/form-data` en el área de pruebas de API - * Se corrigió el comportamiento de los enlaces de anclaje para que, al hacer clic, actualicen la URL sin desplazarse al inicio de la página + * Se corrigió el comportamiento de los enlaces de anclaje para que, al hacer clic, actualicen la URL sin desplazarse a la parte superior de la página * Se corrigieron problemas de enlaces de anclaje en pestañas anidadas ## Actualizaciones del Asistente * Nueva API del Asistente para integrarlo en tus propios productos, compatible con AI SDK - * Se añadió un botón para copiar en las respuestas del chat - * Se corrigió un problema al reintentar mensajes en el asistente - * Mejoras al prompt predeterminado del asistente para que sea menos verboso por defecto + * Se agregó un botón de copiar a las respuestas del chat + * Se corrigió un problema al reintentar mensajes en el Asistente + * Mejoras en el prompt predeterminado del Asistente para que sea menos verboso por defecto ## Rendimiento y confiabilidad * La búsqueda se siente más ágil y precisa al abortar solicitudes con debounce mientras escribes - * Aprovisionamiento de recursos para una nueva CDN: se espera que mejoren pronto los tiempos de carga de imágenes y páginas + * Aprovisionamiento de recursos para una nueva CDN: se espera que pronto mejoren los tiempos de carga de imágenes y de páginas * Se corrigieron errores al renderizar diagramas Mermaid complejos como gráficos de Gantt - * Se corrigieron errores de la CLI en Windows para mejorar la estabilidad y se añadieron pruebas para prevenir regresiones + * Se corrigieron errores de la CLI en Windows para mejorar la estabilidad y se agregaron pruebas para prevenir regresiones ## Mejoras técnicas - * Se añadió OpenTelemetry para trazas en la aplicación Next.js y así mejorar el time to first byte para los clientes - * Migración de Octokit a GitHub API Client para mejorar la latencia en la experiencia del editor web - * Se corrigieron metaetiquetas duplicadas para OpenGraph - * Actualización de MongoDB de la versión 6 a la 7 para mejorar el rendimiento y sumar nuevas funciones + * Se agregó OpenTelemetry para trazas en la aplicación Next.js, mejorando el tiempo hasta el primer byte para los clientes + * Migramos de Octokit a GitHub API Client para reducir la latencia en la experiencia del editor web + * Se corrigieron etiquetas meta duplicadas para Open Graph + * Se actualizó MongoDB de la versión 6 a la 7 para mejorar el rendimiento y añadir nuevas funciones ## Aplicación de Slack - * Acceso sin fricción: el bot responde a MD, @menciones y cualquier pregunta en tu canal `#ask-ai` + * Acceso sin fricción: el bot responde a DMs, @menciones y cualquier pregunta en tu canal `#ask-ai` * Configuración con un clic: instálala directamente desde tu panel de Mintlify en segundos * Respuestas contextuales: busca en toda tu documentación para ofrecer respuestas relevantes y precisas * Reduce interrupciones de soporte: convierte preguntas diarias en respuestas instantáneas de autoservicio - Obtén más información en nuestra [guía de la aplicación de Slack](/es/ai/slack-app). + Más información en nuestra [guía de la aplicación de Slack](/es/ai/slack-app). ## Servidores MCP alojados - Implementa servidores alojados del Model Context Protocol (MCP) directamente a través de Mintlify para integrarte con herramientas de IA como Claude, Cursor y otras. Obtén más información en nuestra [guía de MCP](/es/ai/model-context-protocol). + Implementa servidores alojados de Model Context Protocol (MCP) directamente a través de Mintlify para integrarte con herramientas de IA como Claude, Cursor y otras. Más información en nuestra [guía de MCP](/es/ai/model-context-protocol). Ayuda a los usuarios a conectar rápidamente tu servidor MCP con Cursor o VS Code desde cualquier página de tu documentación mediante el menú contextual. Consulta [Menú contextual](/es/ai/contextual-menu) para más información. - ## Mejoras en los bloques de código + ## Mejoras en bloques de código * Mejor resaltado de sintaxis - * Se añadieron más opciones de personalización, como modo de enfoque, bloques de código expandibles, adaptación a modo oscuro y claro, menú desplegable de lenguaje, numeración de líneas e iconos + * Se agregaron más opciones de personalización, incluyendo modo enfoque, bloques de código expandibles, adaptación a modo oscuro y claro, menú desplegable de lenguaje, numeración de líneas e iconos ## Actualizaciones del asistente de IA * Mayor precisión mediante RAG agentivo con llamadas a herramientas - * Proporciona enlaces navegables a las páginas referenciadas para que los usuarios vayan directamente a la fuente de las respuestas + * Proporciona enlaces navegables a las páginas de referencia para que los usuarios puedan ir directamente a la fuente de las respuestas * Atajo para copiar ejemplos de código generados por el asistente - * Atajo “Ask AI” en bloques de código de la documentación para generar explicaciones con el asistente + * Atajo "Ask AI" en los bloques de código de la documentación para generar explicaciones del Asistente - Obtén más información en la [documentación del asistente](/es/guides/assistant). + Más información en la [documentación del asistente](/es/guides/assistant). ## Registros de cambios suscribibles * Genera automáticamente un feed RSS a partir de las páginas del registro de cambios - * Integra actualizaciones habilitadas por RSS con Slack, correo electrónico y otras herramientas + * Integra actualizaciones habilitadas con RSS con Slack, correo electrónico y otras herramientas - Obtén más información en nuestra nueva [guía de registros de cambios](/es/guides/changelogs) + Más información en nuestra nueva [guía de registro de cambios](/es/guides/changelogs) ## Actualizaciones de estabilidad del área de pruebas de API - * Busca para encontrar un endpoint - * Indica un endpoint en desuso con una etiqueta - * Oculta de la navegación las páginas de API autogeneradas - * Sube archivos multipart o de datos de formulario + * Búsqueda para encontrar un endpoint + * Indica un endpoint obsoleto con una etiqueta + * Oculta páginas de API autogeneradas de la navegación + * Carga archivos multipart o de formulario - Obtén más información en la [documentación del área de pruebas de API](/es/api-playground/) + Más información en la [documentación del área de pruebas de API](/es/api-playground/) ## `mint update` @@ -303,9 +324,9 @@ noindex: true ![Webeditor3 Jpe](/images/webeditor3.jpeg) - Rediseño de la usabilidad en el editor WYSIWYG. + Se renovó por completo la usabilidad del editor WYSIWYG. - **Mejoras principales** + **Mejoras importantes** * Busca nombres de archivos con el atajo ⌘ + P * Las páginas cargan 10 veces más rápido @@ -315,14 +336,14 @@ noindex: true **Correcciones adicionales** - * Se corrigió el margen superior de los componentes del registro de cambios - * Se mejoró la fiabilidad del clic derecho - * Tras publicar, permanecerás en la misma página en lugar de ver un estado vacío - * Colores estandarizados en los iconos de archivos + * Corregido el margen superior en los componentes del registro de cambios + * Mayor fiabilidad del clic derecho + * Tras publicar, permanecerás en la misma página en lugar de pasar a un estado vacío + * Colores estandarizados en los iconos de archivo * Mayor fiabilidad tras seleccionar nuevas ramas varias veces seguidas * Se eliminó el modo Diff * Más consistencia al crear una carpeta nueva desde el menú desplegable - * Se corrigió que las citas en bloque crearan más citas en bloque al intentar deseleccionarlas + * Corregido: las citas en bloque creaban más citas en bloque al intentar deseleccionar ## Traducciones con IA en beta @@ -332,9 +353,9 @@ noindex: true Traduce toda tu documentación con IA. [Más información.](es/navigation#localization) - ## Exportar documentación a PDF en beta + ## Exportar docs a PDF en beta - Exporta toda tu documentación, un subdirectorio o una sola página como PDF. + Exporta toda tu documentación, un subdirectorio o una única página como PDF. ## Compatibilidad con hooks de React @@ -348,37 +369,37 @@ noindex: true ![screenshot of MCP server generator](/images/changelog/mcpgenerator.png) - Genera servidores MCP para que las aplicaciones de IA puedan interactuar con tu documentación o API. El contenido escrito se genera automáticamente como un servidor MCP y puedes generar uno a partir de tu especificación de OpenAPI con un solo clic. + Genera servidores MCP para que las aplicaciones de IA puedan interactuar con tu documentación o APIs. El contenido escrito se genera automáticamente como un servidor MCP, y puedes generar un servidor MCP desde tu especificación OpenAPI con un solo clic. Consulta la [documentación para comenzar con MCP.](/es/ai/model-context-protocol) ## Mejoras * Etiqueta las actualizaciones del registro de cambios para que los usuarios finales puedan filtrarlas - * Sonnet-3.7 compatible con el chat de IA. Configura tu modelo preferido desde el panel - * Cambia el nombre de tu despliegue directamente en la configuración del panel + * Sonnet-3.7 compatible para el chat de IA. Configura tu modelo preferido desde el panel + * Cambia el nombre de tu implementación directamente en la configuración del panel ## Correcciones de errores * Imágenes OG corregidas - * Se corrigió la inconsistencia de estilo de icono en anclas sin contenedor - * Ajustes de estilo mejorados en el borde del panel para responsividad en móvil-tablet-escritorio - * Mostrar ejemplos de código incluso en modo simple en el Área de pruebas de API + * Corregida la inconsistencia de estilo de iconos para anclas sin contenedor + * Ajustes de estilo mejorados en el borde del panel para la adaptabilidad móvil-tableta-escritorio + * Mostrar ejemplos de código incluso en modo simple en el área de pruebas de API * Compatibilidad con el atajo "command + k" para buscar en el editor web - * Los bloques de código dentro de avisos se expanden para ocupar todo el ancho del área del aviso + * Los bloques de código dentro de los avisos se expanden para ocupar todo el ancho del área del aviso ## Nuevo esquema de configuración `docs.json` - ![docs.json screenshot](/images/changelog/docsjson.png) + ![captura de pantalla de docs.json](/images/changelog/docsjson.png) - Hemos introducido un nuevo esquema `docs.json` como reemplazo de `mint.json`, para admitir un mejor versionado multinivel, una comprensión visual más sencilla y una terminología más consistente. Para obtener más información sobre lo que ha cambiado, [consulta nuestro blog](https://mintlify.com/blog/refactoring-mint-json-into-docs-json). + Hemos introducido un nuevo esquema `docs.json` como reemplazo de `mint.json`, para admitir un mejor versionado multinivel, facilitar la comprensión visual y usar una terminología más consistente. Para ver qué cambió, [consulta nuestro blog](https://mintlify.com/blog/refactoring-mint-json-into-docs-json). Actualiza de `mint.json` a `docs.json` con los siguientes pasos: - 1. Asegúrate de que tu CLI esté en la última versión + 1. Asegúrate de tener la última versión de la CLI ```bash npm i mint@latest -g @@ -390,25 +411,25 @@ noindex: true mint upgrade ``` - 1. Elimina tu archivo `mint.json` antiguo y sube tus cambios + 1. Elimina el archivo `mint.json` antiguo y sube tus cambios - ## Comprobaciones de CI + ## Verificaciones de CI - Ejecuta lint automáticamente sobre tu documentación para encontrar enlaces rotos, detectar problemas de ortografía y gramática o aplicar estilos de escritura con tu propia configuración de Vale. Obtén más información en nuestra [documentación](es/settings/ci). + Ejecuta lint automáticamente en tu documentación para encontrar enlaces rotos, detectar errores ortográficos y gramaticales, o aplicar estilos de escritura con tu propia configuración de Vale. Obtén más información en nuestra [documentación](es/settings/ci). ## Compatibilidad .md para LLM - Todas las páginas de documentación ahora están disponibles automáticamente como archivos Markdown sin formato: solo agrega `.md` a la URL. Esto facilita que los LLM procesen páginas individuales de tu documentación. + Todas las páginas de documentación ahora están disponibles automáticamente como archivos Markdown simples: solo añade `.md` a la URL. Esto facilita que los LLM incorporen páginas individuales de tu documentación. ## Más temas - ![graphic with text "Themes v2"](/images/changelog/themes.png) + ![gráfico con texto "Themes v2"](/images/changelog/themes.png) - Nuevos [temas prediseñados](es/themes) para modificar el look & feel de tu documentación. Configúralos desde tu [archivo docs.json](es/settings). + Nuevos [temas prediseñados](es/themes) para modificar el look & feel de tu documentación. Configúralos a través de tu [archivo docs.json](es/settings). - Ahora disponible: + Ahora disponibles: * Maple * Palm @@ -416,84 +437,84 @@ noindex: true ## Otras mejoras - * [Guía de redacción técnica:](https://mintlify.com/guides/introduction) Mejores prácticas para escribir documentación técnica, incluida la investigación de audiencia, los tipos de contenido y consejos de escritura. + * [Guía de redacción técnica:](https://mintlify.com/guides/introduction) Buenas prácticas para escribir documentación técnica, incluyendo investigación de audiencia, tipos de contenido y consejos de escritura. * [Componente Dropdown](es/navigation#dropdowns): Organiza la navegación con un menú desplegable, además de pestañas y anclas. - * [Corrector de sintaxis con IA](https://x.com/ricardonunez_io/status/1892334887644123192): El editor web detectará si hay un error de parsing y usará IA para sugerir correcciones. + * [Corrector de sintaxis con IA](https://x.com/ricardonunez_io/status/1892334887644123192): El Editor web detectará si hay un error de parseo y usará IA para sugerir correcciones. ## Mejoras del Asistente de IA - * Nueva interfaz con página de chat dedicada y prompts predefinidos - * Mejoras de estabilidad, p. ej., corrección de errores al editar el archivo equivocado o ningún archivo en absoluto - * Conocimiento más robusto para agregar y editar componentes + * Nueva interfaz con página de chat dedicada y prompts precargados + * Mejoras de estabilidad. Por ejemplo, correcciones de errores al editar el archivo equivocado o ninguno + * Conocimiento más sólido para agregar y editar componentes * Edición mejorada del archivo `docs.json` ## Autenticación parcial - Personaliza el acceso a cualquier página o sección de contenido según los permisos del usuario. Admite la conexión con tu propio sistema de autenticación. + Personaliza el acceso a cualquier página o sección de contenido según los permisos del usuario. Permite conectarte con tu propio sistema de autenticación. ## Área de pruebas de API renovada - Hemos renovado el diseño y el rendimiento del [Área de pruebas de API](/es/api-playground/). Las actualizaciones incluyen: + Hemos rediseñado el [Área de pruebas de API](/es/api-playground/) y mejorado su rendimiento. Las actualizaciones incluyen: - * Expansión de detalles más sencilla para obtener una vista general de un campo - * Diseño anidado más intuitivo, p. ej., agregar o eliminar elementos + * Expansión de detalles más fácil para obtener una vista general de un campo + * Diseño anidado más intuitivo. Por ejemplo, agregar o eliminar elementos * Tiempos de respuesta más rápidos ## Mejoras de calidad - * Compatibilidad para requerir autenticación para acceder a despliegues de vista previa + * Posibilidad de requerir autenticación para acceder a despliegues de vista previa ## Autenticación - ![Authentication screenshot](/images/changelog/authentication.png) + ![captura de pantalla de Autenticación](/images/changelog/authentication.png) - Vuelve privada la documentación configurando autenticación mediante JWT, OAuth o una contraseña universal. Con esta privacidad, puedes crear una base de conocimiento interna o evitar que los competidores vean tu documentación. + Haz que la documentación sea privada configurando autenticación vía JWT, OAuth o una contraseña universal. Con esta privacidad, puedes crear una base de conocimiento interna o evitar que los competidores vean tu documentación. - ## Redactor de IA + ## Redactor con IA - ![AI Assistant](/images/changelog/ai-assistant.jpg) + ![Asistente de IA](/images/changelog/ai-assistant.jpg) - Ahora puedes pedirle a la IA que haga cambios en tu documentación, con el contexto de toda la documentación existente. Escribe una indicación y el redactor propondrá cambios generando una pull request. + Ahora puedes pedirle a la IA que haga cambios en tu documentación, con el contexto de toda la documentación existente. Escribe una indicación y el redactor propondrá cambios creando una pull request. ## Mejora de la integración con GitLab - Hemos mejorado nuestra compatibilidad con la sincronización con GitLab, habilitando actualizaciones automatizadas y despliegues de vista previa. Consulta nuestra [documentación sobre GitLab](/es/settings/gitlab) para comenzar. + Hemos mejorado la compatibilidad de sincronización con GitLab, habilitando, por ejemplo, actualizaciones automatizadas y despliegues de vista previa. Consulta nuestra [documentación sobre GitLab](/es/settings/gitlab) para comenzar. ## Editor web - ![Web Editor](/images/changelog/webeditor.jpg) + ![Editor web](/images/changelog/webeditor.jpg) - Hemos renovado nuestro Editor web para que ahora puedas actualizar la documentación con una experiencia WYSIWYG completa, mientras se sincroniza con Markdown. + Hemos renovado nuestro editor web para que ahora puedas actualizar la documentación con una experiencia WYSIWYG completa, mientras se sincroniza con Markdown. - Consulta nuestra [documentación para comenzar con el Editor web](/es/editor). + Consulta nuestra [documentación para empezar con el Editor web](/es/editor). ## Compatibilidad con /llms.txt - ![llms.txt support](/images/changelog/llms.jpg) + ![Compatibilidad con llms.txt](/images/changelog/llms.jpg) - Todas las instancias de documentación ahora se alojan automáticamente en /llms.txt y /llms-full.txt para que los LLM puedan incorporar tu documentación fácilmente. Para obtener más información, lee la [documentación sobre el nuevo estándar llms.txt.](https://llmstxt.org) + Todas las instancias de documentación ahora se alojan automáticamente en /llms.txt y /llms-full.txt para que los LLM puedan incorporar fácilmente tu documentación. Para obtener más información, lee la [documentación sobre el nuevo estándar llms.txt.](https://llmstxt.org) ## Localización - Ahora puedes localizar tu documentación, lo cual funciona de manera similar al versionado. Agrega un `locale` a una versión y el contenido fijo en Mintlify, como “Was this page helpful?”, también coincidirá con el locale. + Ahora puedes localizar tu documentación, de forma similar al versionado. Añade un `locale` a una versión y el contenido fijo de Mintlify, como “Was this page helpful?”, también coincidirá con ese locale. ### Mejoras de calidad - * Devolver resultados de chat y búsqueda según la versión actual que el usuario esté leyendo + * Devolver resultados de chat y búsqueda según la versión que el usuario esté leyendo * Autenticar a los usuarios con OAuth, además de JWT o tokens de sesión compartida. @@ -503,14 +524,14 @@ noindex: true Lanzamos un nuevo [Componente de actualización](/es/components/update) para facilitar la visualización y comunicación de actualizaciones (como esta) a tus usuarios. - ![Changelog](/images/changelog/changelog.jpg) + ![Registro de cambios](/images/changelog/changelog.jpg) ## Resaltado de líneas de código - Ahora puedes resaltar líneas de código en tu documentación para enfatizar y llamar la atención sobre partes importantes añadiendo un comentario especial después del identificador del lenguaje. Usa llaves `{}` y especifica números de línea o rangos separados por comas. + Ahora puedes resaltar líneas de código en tu documentación para enfatizar y llamar la atención sobre partes importantes agregando un comentario especial después del identificador del lenguaje. Usa llaves `{}` y especifica números de línea o rangos separados por comas. - ```javascript Ejemplo de resaltado de líneas {1,3-5} + ```javascript Line Highlighting Example {1,3-5} const greeting = "Hello, World!"; function sayHello() { console.log(greeting); @@ -519,7 +540,7 @@ noindex: true ``` ````mdx - ```javascript Ejemplo de resaltado de líneas {1,3-5} + ```javascript Line Highlighting Example {1,3-5} const greeting = "Hello, World!"; function sayHello() { console.log(greeting); @@ -530,7 +551,7 @@ noindex: true ## Bloques de código en modo claro - Los bloques de código ahora tienen una variante en modo claro que puede habilitarse añadiendo lo siguiente a tu `docs.json`: + Los bloques de código ahora tienen una variante en modo claro que se puede habilitar agregando lo siguiente a tu `docs.json`: ```json "codeBlock": { @@ -541,41 +562,41 @@ noindex: true ## Pie de página avanzado - ![Advanced Footer](/images/changelog/advanced-footer.gif) + ![Pie de página avanzado](/images/changelog/advanced-footer.gif) - Ahora puedes añadir más enlaces al pie de página estándar. Esta mejora - aporta más consistencia entre las landing pages y la documentación, o mayor personalización - si quieres destacar páginas específicas como redes sociales o registros de estado. + Ahora puedes agregar más enlaces al pie de página estándar. Esta mejora + ofrece más coherencia entre las landing pages y la documentación, o mayor personalización + si quieres destacar páginas específicas como redes sociales o páginas de estado. ## Filtrar la búsqueda según el usuario actual - Cuando la personalización está habilitada, los resultados de búsqueda se filtran según el usuario que haya iniciado sesión para que solo vea el contenido relevante. + Cuando la Personalización está habilitada, los resultados de búsqueda ahora se filtran según el usuario que haya iniciado sesión, para que solo vea el contenido relevante. ## Prompts personalizados para el chat de IA - Ahora puedes personalizar los prompts del chat de IA. Comunícate con [support](mailto:support@mintlify.com) si quieres personalizarlos. + Ahora puedes personalizar los prompts del chat de IA. Comunícate con [support](mailto:support@mintlify.com) si deseas personalizar los prompts. - ## Mejoras del panel + ## Mejoras en el panel - * Se añadió la opción de cambiar el dominio personalizado para que sea /docs directamente desde la configuración del panel. + * Se añadió la posibilidad de cambiar el dominio personalizado a /docs directamente desde la configuración del panel. * Se unificaron las páginas de inicio de sesión y registro para reducir la fricción y la confusión. - * Se implementó el flujo de inicio de sesión por descubrimiento para que los usuarios que pertenecen a varias organizaciones puedan cambiar entre ellas. + * Se implementó el flujo de inicio de sesión con descubrimiento para que los usuarios que son miembros de varias organizaciones puedan cambiar entre ellas. * Se añadió inicio de sesión con Google OAuth. - * Se añadió la opción de crear un nuevo despliegue desde la configuración del panel. + * Se añadió la posibilidad de agregar un nuevo deployment desde la configuración del panel. ## Correcciones de errores * Ya se pueden usar barras iniciales en la navegación. - * Ya se pueden editar archivos CSS y JS en el editor web. + * Ya se pueden editar archivos CSS y JS en el Editor web. * Se corrigió que `suggestEdit` no apareciera incluso cuando estaba habilitado. - * Se corrigió la navegación por teclado para Search y Chat, de modo que ahora puedes usar las teclas de flecha arriba y abajo para recorrer los resultados. + * Se corrigió la navegación por teclado para Búsqueda y Chat, de modo que ahora puedes usar las flechas arriba y abajo para desplazarte por los resultados. * No permitir que los motores de búsqueda rastreen páginas protegidas por autenticación de usuario. * Revalidar la caché cuando se elimina una organización. - * Ahora usamos el analizador OpenAPI de Scalar para procesar definiciones de OpenAPI, lo que mejora el rendimiento, corrige problemas de análisis y muestra mensajes de error más claros. - * Ya se admiten descripciones de nivel superior en las páginas de referencia de API autogeneradas a partir de definiciones de OpenAPI. - * Se agregó compatibilidad con estilos en línea para iconos. - * Se corrigió la aparición repentina del CSS personalizado en la documentación. + * Ahora usamos el parser de OpenAPI de Scalar para analizar definiciones de OpenAPI, lo que mejora el rendimiento, corrige problemas de parsing y ofrece mejores mensajes de error. + * Ahora se admiten descripciones de nivel superior en las páginas de referencia de API generadas automáticamente a partir de definiciones de OpenAPI. + * Añadido soporte de estilo inline para iconos. + * Se corrigió el “pop-in” del CSS personalizado en la documentación. * Mostrar correctamente el estilo de código en línea junto con enlaces. * Mantener la posición de desplazamiento al hacer clic en el botón Atrás del navegador. @@ -587,7 +608,7 @@ noindex: true ![Fuentes personalizadas](/images/changelog/custom-fonts.jpeg) - Personaliza la tipografía de tu documentación con tu propia fuente alojada en un CDN o eligiendo entre Google Fonts para alinear tus docs con tu marca. + Personaliza la tipografía de tu documentación usando tu propia fuente alojada en un CDN o eligiendo entre Google Fonts para alinear tu documentación con tu marca. ## Imágenes en componentes Card @@ -599,9 +620,9 @@ noindex: true ![Mejoras de rendimiento](/images/changelog/performance-improvements.png) - Para proyectos grandes (~3,000 archivos), el paso de descarga para las actualizaciones de docs ahora es - ~440x más rápido: una reducción del 99.8% en el tiempo. En general, las descargas de archivos durante - las actualizaciones ahora son ~5.5x más rápidas: una reducción del 81.8% en el tiempo. + Para proyectos grandes (~3,000 archivos), el paso de descarga de las actualizaciones de la documentación ahora es + ~440x más rápido: una reducción del 99.8% del tiempo. En general, las descargas de archivos durante + las actualizaciones ahora son ~5.5x más rápidas: una reducción del 81.8% del tiempo. ## Mejoras de SEO @@ -609,25 +630,25 @@ noindex: true ![Mejoras de SEO](/images/changelog/seo-improvements.jpeg) - Hemos corregido tanto el diseño móvil como el de escritorio de nuestras docs para que sean más compatibles con SEO, incluyendo la incorporación de etiquetas aria adecuadas en la barra de navegación y en los elementos de alternancia. + Hemos corregido el diseño móvil y de escritorio de nuestra documentación para que sea más compatible con SEO, incluido añadir etiquetas aria adecuadas a la barra de navegación y a los elementos de alternancia. - ## Mejoras del panel + ## Mejoras en el panel - * Migración al App Router en el panel. + * Migración a App Router en el panel. * Las analíticas de búsqueda ahora están disponibles en el panel. * Se agregó la funcionalidad para eliminar una organización en el panel. - * Se lanzó la UI de conexión con GitLab. + * Se lanzó la interfaz de conexión con GitLab. * Corrección de datos de analíticas incorrectos. - * Ahora los complementos pueden comprarse directamente a través del panel. + * Los complementos ahora se pueden comprar directamente desde el panel. ## Correcciones de errores - * Se corrigió un error por el que la barra superior no se ajustaba al ancho de la pantalla cuando estaba en modo personalizado y el diseño de la barra lateral era `sidenav`. - * Corrección del posicionamiento relativo del widget de IA. + * Se corrigió un error donde la barra superior no se ajustaba al ancho de la pantalla cuando estaba en modo personalizado y el diseño de la barra lateral era `sidenav`. + * Se corrigió el posicionamiento relativo del widget de IA. ## Más - * **Solución de problemas para páginas de API**: Las páginas de API pueden ser complicadas, así que enumeramos + * **Solución de problemas para páginas de API**: las páginas de API pueden ser complicadas, por lo que enumeramos problemas comunes para ayudarte a resolverlos rápidamente — [Lee la documentación](/es/api-playground/troubleshooting) @@ -643,16 +664,16 @@ noindex: true ## Carga de archivos en el Área de pruebas de API - De forma predeterminada, las solicitudes del Área de pruebas de API pasan por un proxy de Mintlify. Ahora puedes usar - `disableProxy` para desactivar este comportamiento y admitir tipos de solicitudes como - la carga de archivos. + De forma predeterminada, las solicitudes del Área de pruebas de API se enrutan a través de Mintlify. Ahora puedes usar + `disableProxy` para desactivar este comportamiento y admitir tipos de solicitud como la + carga de archivos. * [Más información sobre configuraciones de API](es/settings#api-configurations) ## Mejoras de SEO en móviles - Hemos corregido el diseño móvil de nuestras docs para que sea más compatible con SEO, - incluyendo la incorporación de etiquetas aria adecuadas en los elementos. + Hemos corregido el diseño móvil de nuestra documentación para que sea más compatible con SEO, + incluido añadir etiquetas aria adecuadas a los elementos. ## Formulario de soporte @@ -662,9 +683,9 @@ noindex: true ## Correcciones de errores * Se corrigió un error en la funcionalidad de la integración con Segment. - * Ahora mostramos mensajes de error más granulares para los permisos de GitHub al + * Ahora mostramos mensajes de error más granulares para permisos de GitHub al interactuar con el editor. - * Se corrigieron errores por los que la navegación no se expandía correctamente cuando se usaba un enlace directo. + * Se corrigieron errores donde la navegación no se expandía correctamente cuando se usaba un enlace directo. @@ -674,9 +695,9 @@ noindex: true ![Widget de IA](/images/changelog/widget.png) - Para usuarios `Pro`, presentamos Mintlify Widget, una extensión de tus docs para - responder las preguntas de tus usuarios cuando y donde las hagan. Puedes agregar este - chatbot con IA a cualquier página web: tu landing page, dentro de tu producto o + Para usuarios `Pro`, presentamos Mintlify Widget, una extensión de tu documentación para + responder a las preguntas de tus usuarios cuando y donde las hagan. Puedes agregar este + chatbot con IA a cualquier página web: tu página de inicio, dentro de tu producto o en tus páginas de documentación existentes. * [Lee el anuncio en el blog](https://mintlify.com/blog/widget) @@ -687,24 +708,25 @@ noindex: true * [Lee el anuncio en el blog](https://mintlify.com/blog/pro-plan) - ## Sincronización de ejemplos de código en el Área de pruebas de API + ## Sincronización de ejemplos de código del Área de pruebas de API Cuando navegas por la documentación de API, el ejemplo de código seleccionado ahora se sincroniza entre tus páginas. ## Insights - Actualmente en beta, esta función resume preguntas comunes de los usuarios y patrones - en informes fáciles de digerir, con sugerencias impulsadas por IA sobre cómo mejorar tu producto. + Actualmente en beta, esta función resume preguntas y patrones comunes de los usuarios + en informes fáciles de digerir con sugerencias impulsadas por IA sobre cómo mejorar tu + producto. ## Lo más destacado de la Launch Week - * Temas: Personaliza el estilo con temas preconfigurados. Solo agrega el tema Quill, Prism o Venus a tu archivo `docs.json` y se actualizará el estilo de tu documentación. - * Search V2: consulta directamente las descripciones y títulos de endpoints de OpenAPI para llegar a las páginas de Referencia de API, excluye páginas ocultas de la búsqueda y aprovecha nuestra barra de búsqueda renovada. - * Ramificación en el Editor web: crea ramas en nuestro editor web sin un IDE. - * Personalización de usuario: autentica a los usuarios con Shared Session o JWT para mostrarles contenido personalizado, como el prerellenado de claves de API o contenido específico para clientes. - * Mejoras de automatización de OpenAPI: para autocompletar las páginas del Área de pruebas de API, puedes agregar un campo `openapi` a un objeto en los arreglos tabs o anchors en el `docs.json`. + * Temas: personaliza el estilo con temas preconfigurados. Solo agrega el tema Quill, Prism o Venus a tu archivo `docs.json` y se actualizará el diseño de tu documentación. + * Search V2: consulta directamente las descripciones y los títulos de los endpoints de OpenAPI para ir a las páginas de Referencia de API, elimina las páginas ocultas de la búsqueda y disfruta de nuestra barra de búsqueda renovada. + * Ramificación en el Editor web: crea ramas en nuestro Editor web sin usar un IDE. + * Personalización de usuarios: autentica a los usuarios con Shared Session o JWT para mostrarles contenido personalizado, como el prerellenado de claves de API o contenido específico para clientes. + * Mejoras de automatización de OpenAPI: para autopoblar las páginas del Área de pruebas de API, puedes agregar un campo `openapi` a un objeto en los arreglos tabs o anchors en el `docs.json`. @@ -721,35 +743,35 @@ noindex: true ## Modo personalizado Agrega una configuración a los metadatos para eliminar todos los elementos excepto la barra superior. - Casos de uso: + Casos de uso de ejemplo: - * Crea una página de inicio global personalizada con componentes personalizados + * Crea una página de inicio global personalizada con componentes a medida * Agrega videos a pantalla completa o galerías de imágenes - * Inserta elementos de demostración iFrame personalizados para añadir interactividad a tu documentación + * Inserta elementos de demostración iFrame personalizados para agregar interactividad a tu documentación - Consulta nuestra [documentación de Modo personalizado](es/pages#custom-mode). + Consulta nuestra [documentación de Custom Mode](es/pages#custom-mode). - ## MDX de Mintlify para VSCode + ## Mintlify MDX para VSCode - Inserta fragmentos de nuestros componentes y avisos preconstruidos sin salir de VSCode. [Instala la extensión aquí](https://marketplace.visualstudio.com/items?itemName=mintlify.mintlify-snippets). + Inserta fragmentos de nuestros componentes y avisos prediseñados sin salir de VSCode. [Instala la extensión aquí](https://marketplace.visualstudio.com/items?itemName=mintlify.mintlify-snippets). ## Mejoras de calidad - * Mejoras del panel: visualiza los registros de actualizaciones para ver qué cambió y el estado de cada actualización; alterna entre proyectos de Mintlify para gestionar despliegues + * Mejoras del panel: visualiza registros de actualización para ver qué cambió y el estado de una actualización; alterna entre proyectos de Mintlify para gestionar implementaciones * Versionado con pestañas totalmente compatible - * Redirecciones con comodín ahora compatibles - * Detección de errores en la CLI: ahora mostramos la posición del frontmatter no válido cuando hay problemas de parsing durante el desarrollo local + * Redirecciones con comodines ahora compatibles + * Detección de errores en la CLI: ahora mostramos la posición del frontmatter no válido cuando hay problemas de análisis durante el desarrollo local ## Lo más destacado de la Launch Week - * Despliegues de vista previa: cuando creas una pull request, generaremos un enlace único que muestra una vista previa en vivo de cómo se ve tu documentación en producción. Puedes compartir este enlace con tu equipo. - * Fragmentos V2: ahora admitimos componentes y variables completamente reutilizables para los Fragmentos. - * Motor MDX de código abierto: hemos expuesto dos API—getCompiledMdx y MDXComponent—para que puedas acceder al Markdown de Mintlify y al resaltado de sintaxis de código. [Las contribuciones al proyecto](https://github.com/mintlify/mdx) son bienvenidas. - * Insights de chat de IA: segmenta el historial de chat por fecha, aumenta la cuota del Chat de IA desde el panel y ve con qué frecuencia aparece una consulta específica. + * Implementaciones de vista previa: cuando creas una pull request, generaremos un enlace único que muestra una vista previa en vivo de cómo se ve tu documentación en producción. Puedes compartir este enlace con tu equipo. + * Fragmentos V2: ahora admitimos componentes y variables completamente reutilizables para los fragmentos. + * Motor MDX de código abierto: hemos expuesto dos API—getCompiledMdx y MDXComponent—para que puedas acceder al Markdown de Mintlify y al resaltado de sintaxis de código. [Se aceptan contribuciones al proyecto](https://github.com/mintlify/mdx). + * Insights de AI Chat: segmenta el historial de chat por fecha, aumenta la cuota de AI Chat desde el panel y ve con qué frecuencia aparece una consulta específica. \ No newline at end of file diff --git a/es/code.mdx b/es/code.mdx index 109054c1e..0d4088c11 100644 --- a/es/code.mdx +++ b/es/code.mdx @@ -14,7 +14,7 @@ Puedes agregar fragmentos de código en línea o bloques de código. Los bloques ### Código en línea -Para marcar una `palabra` o `frase` como código, enciérrala entre comillas invertidas (`). +Para indicar una `palabra` o `frase` como código, enciérrala entre acentos graves (`). ```mdx Para marcar una `palabra` o `frase` como código, enciérrala entre comillas invertidas (`). @@ -24,14 +24,14 @@ Para marcar una `palabra` o `frase` como código, enciérrala entre comillas inv ### Bloques de código -Usa [bloques de código delimitados](https://www.markdownguide.org/extended-syntax/#fenced-code-blocks) encerrando el código entre tres comillas invertidas. Los bloques de código se pueden copiar y, si tienes el Asistente habilitado, los usuarios pueden pedir a la IA que explique el código. +Usa [bloques de código delimitados](https://www.markdownguide.org/extended-syntax/#fenced-code-blocks) encerrando el código entre tres comillas invertidas. Los bloques de código se pueden copiar y, si tienes el Asistente habilitado, los usuarios pueden pedirle a la IA que explique el código. Especifica el lenguaje de programación para el resaltado de sintaxis y para habilitar opciones meta. Agrega cualquier opción meta, como un título o un icono, después del lenguaje. ```java HelloWorld.java lines icon="java" class HelloWorld { public static void main(String[] args) { - System.out.println("Hello, World!"); + System.out.println("¡Hola, Mundo!"); } } ``` @@ -40,41 +40,43 @@ class HelloWorld { ```java HelloWorld.java lines icon="java" class HelloWorld { public static void main(String[] args) { - System.out.println("Hello, World!"); + System.out.println("¡Hola, Mundo!"); } } ``` ````
- ## Opciones de bloques de código + ## Opciones de los bloques de código
-Puedes agregar opciones meta a tus bloques de código para personalizar su apariencia. +Puedes añadir opciones meta a tus bloques de código para personalizar su apariencia. - Debes especificar un lenguaje de programación para un bloque de código antes de agregar cualquier otra opción meta. + Debes especificar un lenguaje de programación para un bloque de código antes de añadir cualquier otra opción meta.
- ### Sintaxis de las opciones + ### Sintaxis de opciones
-* **Opciones de cadena y booleanas**: Envuelve con `""`, `''` o sin comillas. -* **Opciones de expresión**: Envuelve con `{}`, `""` o `''`. +* **Opciones de cadena y booleanas**: Envuélvelas con `""`, `''` o sin comillas. +* **Opciones de expresión**: Envuélvelas con `{}`, `""` o `''`.
### Resaltado de sintaxis
-Habilita el resaltado de sintaxis especificando el lenguaje de programación después de las comillas invertidas de apertura de un bloque de código. +Activa el resaltado de sintaxis indicando el lenguaje de programación después de las comillas invertidas de apertura de un bloque de código. Usamos [Shiki](https://shiki.style/) para el resaltado de sintaxis y admitimos todos los lenguajes disponibles. Consulta la lista completa de [lenguajes](https://shiki.style/languages) en la documentación de Shiki. +Personaliza globalmente los temas de los bloques de código usando `styling.codeblocks` en tu archivo `docs.json`. Establece temas simples como `system` o `dark`, o configura [temas de Shiki](https://shiki.style/themes) personalizados para los modos claro y oscuro. Consulta [Settings](/es/settings#styling) para ver las opciones de configuración detalladas. + ```java class HelloWorld { public static void main(String[] args) { - System.out.println("Hello, World!"); + System.out.println("¡Hola, Mundo!"); } } ``` @@ -83,7 +85,7 @@ class HelloWorld { ```java class HelloWorld { public static void main(String[] args) { - System.out.println("Hello, World!"); + System.out.println("¡Hola, Mundo!"); } } ``` @@ -93,14 +95,14 @@ class HelloWorld { ### Título -Agrega un título para tu ejemplo de código. Usa `title="Your title"` o una cadena en una sola línea. +Añade un título para etiquetar tu ejemplo de código. Usa `title="Your title"` o una cadena en una sola línea. ```javascript Code Block Example -const hello = "world"; +const hello = "mundo"; ``` ````mdx -```javascript Code Block Example +```javascript Ejemplo de Bloque de Código const hello = "world"; ``` ```` @@ -109,10 +111,10 @@ const hello = "world"; ### Icono -Agrega un icono a tu bloque de código usando la propiedad `icon`. Consulta [Icons](/es/components/icons) para ver todas las opciones disponibles. +Añade un icono a tu bloque de código con la propiedad `icon`. Consulta [Iconos](/es/components/icons) para ver todas las opciones disponibles. ```javascript icon="square-js" -const hello = "world"; +const hello = "mundo"; ``` ````mdx @@ -125,10 +127,10 @@ const hello = "world"; ### Resaltado de líneas -Resalta líneas específicas en tus bloques de código usando `highlight` con los números o rangos de líneas que deseas resaltar. +Resalta líneas específicas en tus bloques de código usando `highlight` con los números de línea o los rangos que quieras resaltar. ```javascript Line Highlighting Example highlight= {1-2,5} -const greeting = "Hello, World!"; +const greeting = "¡Hola, Mundo!"; function sayHello() { console.log(greeting); } @@ -136,8 +138,8 @@ sayHello(); ``` ````mdx -```javascript Line Highlighting Example highlight={1-2,5} -const greeting = "Hello, World!"; +```javascript Ejemplo de Resaltado de Líneas highlight={1-2,5} +const greeting = "¡Hola, Mundo!"; function sayHello() { console.log(greeting); } @@ -149,10 +151,10 @@ sayHello(); ### Enfoque de líneas -Enfoca líneas específicas en tus bloques de código usando `focus` con números o rangos de líneas. +Resalta líneas específicas en tus bloques de código usando `focus` con números de línea o rangos. ```javascript Line Focus Example focus= {2,4-5} -const greeting = "Hello, World!"; +const greeting = "¡Hola, Mundo!"; function sayHello() { console.log(greeting); } @@ -161,7 +163,7 @@ sayHello(); ````mdx ```javascript Line Focus Example focus={2,4-5} -const greeting = "Hello, World!"; +const greeting = "¡Hola, Mundo!"; function sayHello() { console.log(greeting); } @@ -176,7 +178,7 @@ sayHello(); Muestra los números de línea en el lado izquierdo de tu bloque de código usando `lines`. ```javascript Show Line Numbers Example lines -const greeting = "Hello, World!"; +const greeting = "¡Hola, Mundo!"; function sayHello() { console.log(greeting); } @@ -184,8 +186,8 @@ sayHello(); ``` ````mdx -```javascript Show Line Numbers Example lines -const greeting = "Hello, World!"; +```javascript Mostrar números de línea Líneas de ejemplo +const greeting = "¡Hola, Mundo!"; function sayHello() { console.log(greeting); } @@ -197,7 +199,7 @@ sayHello(); ### Expandible -Permite que los usuarios expandan y contraigan bloques de código largos usando `expandable`. +Permite que los usuarios expandan y contraigan bloques de código largos con `expandable`. ```python Expandable Example expandable from datetime import datetime, timedelta @@ -215,11 +217,11 @@ class Book: class Library: def __init__(self): self.books: Dict[str, Book] = {} - self.checkouts: Dict[str, List[str]] = {} # usuario -> lista de ISBN + self.checkouts: Dict[str, List[str]] = {} # usuario -> lista de ISBNs def add_book(self, book: Book) -> None: if book.isbn in self.books: - raise ValueError(f"Ya existe un libro con el ISBN {book.isbn}") + raise ValueError(f"El libro con ISBN {book.isbn} ya existe") self.books[book.isbn] = book def checkout_book(self, isbn: str, patron: str, days: int = 14) -> None: @@ -231,10 +233,10 @@ class Library: raise ValueError("Libro no encontrado") if book.checked_out: - raise ValueError("El libro ya está retirado") + raise ValueError("El libro ya está en préstamo") if len(self.checkouts[patron]) >= 3: - raise ValueError("El usuario alcanzó el límite de préstamos") + raise ValueError("El usuario ha alcanzado el límite de préstamos") book.checked_out = True book.due_date = datetime.now() + timedelta(days=days) @@ -243,7 +245,7 @@ class Library: def return_book(self, isbn: str) -> float: book = self.books.get(isbn) if not book or not book.checked_out: - raise ValueError("Libro no encontrado o no retirado") + raise ValueError("Libro no encontrado o no está en préstamo") late_fee = 0.0 if datetime.now() > book.due_date: @@ -253,8 +255,8 @@ class Library: book.checked_out = False book.due_date = None - # Quitar de los préstamos del usuario - for patron, books in self.checkouts.items(): + # Remove from patron's checkouts + # Eliminar de los préstamos del usuario if isbn in books: books.remove(isbn) break @@ -283,14 +285,14 @@ def main(): # Ejemplo de préstamo y devolución library.checkout_book("978-0-261-10295-4", "patron123") late_fee = library.return_book("978-0-261-10295-4") - print(f"Recargo por demora: ${late_fee:.2f}") + print(f"Multa por retraso: ${late_fee:.2f}") if __name__ == "__main__": main() ``` ````mdx -```python Expandable Example expandable +```python Ejemplo Expandible expandible from datetime import datetime, timedelta from typing import Dict, List, Optional from dataclasses import dataclass @@ -303,13 +305,13 @@ if __name__ == "__main__": ````
- ### Ajuste + ### Wrap
-Activa el ajuste de texto para líneas largas usando `wrap`. Esto evita el desplazamiento horizontal y facilita la lectura de líneas extensas. +Habilita el ajuste de texto para líneas largas con `wrap`. Esto evita el desplazamiento horizontal y facilita la lectura de líneas largas. ```javascript Wrap Example wrap -const greeting = "Hello, World! I am a long line of text that will wrap to the next line."; +const greeting = "¡Hola, Mundo! Soy una línea larga de texto que se ajustará a la siguiente línea."; function sayHello() { console.log(greeting); } @@ -318,7 +320,7 @@ sayHello(); ````mdx ```javascript Wrap Example wrap -const greeting = "Hello, World! I am a long line of text that will wrap to the next line."; +const greeting = "¡Hola, Mundo! Soy una línea larga de texto que se ajustará a la siguiente línea."; function sayHello() { console.log(greeting); } @@ -330,36 +332,36 @@ sayHello(); ### Diff -Muestra un diff visual de líneas agregadas o eliminadas en tus bloques de código. Las líneas agregadas se resaltan en verde y las eliminadas en rojo. +Muestra un diff visual de las líneas añadidas o eliminadas en tus bloques de código. Las líneas añadidas se resaltan en verde y las eliminadas se resaltan en rojo. -Para crear diffs, añade estos comentarios especiales al final de las líneas en tu bloque de código: +Para crear diffs, agrega estos comentarios especiales al final de las líneas en tu bloque de código: -* `// [!code ++]`: marca una línea como agregada (resaltado en verde). -* `// [!code --]`: marca una línea como eliminada (resaltado en rojo). +* `// [!code ++]`: Marca una línea como añadida (resaltado en verde). +* `// [!code --]`: Marca una línea como eliminada (resaltado en rojo). Para varias líneas consecutivas, especifica el número de líneas después de dos puntos: -* `// [!code ++:3]`: marca la línea actual más las dos siguientes como agregadas. -* `// [!code --:5]`: marca la línea actual más las cuatro siguientes como eliminadas. +* `// [!code ++:3]`: Marca la línea actual más las dos siguientes como añadidas. +* `// [!code --:5]`: Marca la línea actual más las cuatro siguientes como eliminadas. -La sintaxis de comentarios debe coincidir con tu lenguaje de programación (por ejemplo, `//` para JavaScript o `#` para Python). +La sintaxis de los comentarios debe coincidir con tu lenguaje de programación (por ejemplo, `//` para JavaScript o `#` para Python). ```js Diff Example icon="code" lines -const greeting = "Hello, World!"; // [!code ++] +const greeting = "¡Hola, Mundo!"; // [!code ++] function sayHello() { - console.log("Hello, World!"); // [!code --] + console.log("¡Hola, Mundo!"); // [!code --] console.log(greeting); // [!code ++] } sayHello(); ``` ````text -```js Diff Example icon="code" lines -const greeting = "Hello, World!"; // [!code ++] +```js Ejemplo de Diff icon="code" lines +const greeting = "¡Hola, Mundo!"; // [!code ++] function sayHello() { - console.log("Hello, World!"); // [!code --] + console.log("¡Hola, Mundo!"); // [!code --] console.log(greeting); // [!code ++] } sayHello(); ``` -```` \ No newline at end of file +```` diff --git a/es/components/accordions.mdx b/es/components/accordions.mdx index f7ae43ea6..aac729359 100644 --- a/es/components/accordions.mdx +++ b/es/components/accordions.mdx @@ -6,33 +6,33 @@ icon: "chevron-down" import IconsOptional from "/snippets/es/icons-optional.mdx"; -Los acordeones permiten a los usuarios desplegar y contraer secciones de contenido. Usa acordeones para la divulgación progresiva y para organizar la información. - +Los acordeones permiten a los usuarios expandir y contraer secciones de contenido. Utiliza acordeones para la revelación progresiva y para organizar la información.
## Acordeón individual
- - Puedes incluir cualquier contenido aquí, incluidos otros componentes, como código: - ```java HelloWorld.java - class HelloWorld { - public static void main(String[] args) { - System.out.println("Hello, World!"); - } - } - ``` + + Puedes poner cualquier contenido aquí, incluidos otros componentes, como código: + + ```java HelloWorld.java + class HelloWorld { + public static void main(String[] args) { + System.out.println("Hello, World!"); + } + } + ``` -````mdx Accordion example - - Puedes incluir cualquier contenido aquí, incluidos otros componentes, como código: +````mdx Ejemplo de acordeón + + Puedes incluir cualquier contenido aquí, incluso otros componentes, como código: ```java HelloWorld.java class HelloWorld { public static void main(String[] args) { - System.out.println("Hello, World!"); + System.out.println("¡Hola, mundo!"); } } ``` @@ -40,16 +40,15 @@ Los acordeones permiten a los usuarios desplegar y contraer secciones de conteni ```` -
## Grupos de acordeones
-Agrupa acordeones relacionados con ``. Esto crea una sección coherente de acordeones que se pueden expandir o contraer individualmente. +Agrupa acordeones relacionados usando ``. Esto crea una sección coherente de acordeones que se pueden expandir o contraer individualmente. - - Puedes incluir otros componentes dentro de los acordeones. + + Puedes colocar otros componentes dentro de los acordeones. ```java HelloWorld.java class HelloWorld { @@ -60,55 +59,54 @@ Agrupa acordeones relacionados con ``. Esto crea una sección co ``` - - Añade iconos para que los acordeones sean más distintivos y fáciles de explorar visualmente. + + Agrega íconos para que los acordeones sean más distintivos visualmente y fáciles de explorar. - - + + Mantén el contenido relacionado organizado en grupos. -````mdx Accordion Group Example +````mdx Ejemplo de grupo de acordeones - - You can put other components inside Accordions. + + Puedes incluir otros componentes dentro de los acordeones. ```java HelloWorld.java class HelloWorld { public static void main(String[] args) { - System.out.println("Hello, World!"); + System.out.println("¡Hola, mundo!"); } } ``` - - Add icons to make accordions more visually distinct and scannable. + + Añade iconos para que los acordeones sean más diferenciables y fáciles de escanear visualmente. - - Keep related content organized into groups. + + Mantén el contenido relacionado organizado en grupos. ```` -
## Propiedades
- Título en la vista previa del Accordion. + Título en la vista previa del acordeón. - Detalle debajo del título en la vista previa del Accordion. + Detalle debajo del título en la vista previa del acordeón. - Indica si el Accordion está abierto de forma predeterminada. + Si el acordeón se abre de forma predeterminada. diff --git a/es/components/banner.mdx b/es/components/banner.mdx index 2d65d29e0..8c8b1a427 100644 --- a/es/components/banner.mdx +++ b/es/components/banner.mdx @@ -4,14 +4,14 @@ description: "Añade un banner para mostrar anuncios y notificaciones importante icon: "layout-panel-top" --- -Usa banners para mostrar anuncios, actualizaciones o notificaciones importantes en todo tu sitio de documentación. Los banners aparecen en la parte superior de cada página, admiten formato Markdown y pueden hacerse descartables. +Usa banners para mostrar anuncios, actualizaciones o notificaciones importantes en todo tu sitio de documentación. Los banners aparecen en la parte superior de cada página, admiten formato Markdown y se pueden hacer descartables. Para añadir un banner, usa la propiedad `banner` en tu `docs.json`: ```json Product announcements wrap "banner": { - "content": "🚀 ¡La versión 2.0 ya está disponible! Consulta nuestro [registro de cambios](/changelog) para más detalles.", + "content": "🚀 La versión 2.0 ya está disponible. Consulta nuestro [registro de cambios](/changelog) para más detalles.", "dismissible": true } ``` @@ -25,7 +25,7 @@ Para añadir un banner, usa la propiedad `banner` en tu `docs.json`: ```json Required actions wrap "banner": { - "content": "**Acción requerida:** Migra a nuestra nueva versión antes del 1 de enero. [Guía de migración](/migration)", + "content": "**Acción requerida:** migra a nuestra nueva versión antes del 1 de enero. [Guía de migración](/migration)", "dismissible": true } ``` @@ -40,5 +40,5 @@ Para añadir un banner, usa la propiedad `banner` en tu `docs.json`: - Indica si los usuarios pueden descartar el banner. Cuando `true`, los usuarios pueden cerrar el banner y no volverá a aparecer durante su sesión. El valor predeterminado es `false`. + Indica si los usuarios pueden cerrar el banner. Cuando `true`, los usuarios pueden cerrarlo y no volverá a aparecer durante su sesión. De manera predeterminada es `false`. \ No newline at end of file diff --git a/es/components/callouts.mdx b/es/components/callouts.mdx index 6e1d73197..0f9b9fdbd 100644 --- a/es/components/callouts.mdx +++ b/es/components/callouts.mdx @@ -1,10 +1,10 @@ --- -title: "Avisos" -description: "Usa avisos para añadir contexto llamativo a tu contenido" -icon: 'info' +title: "Llamadas" +description: "Usa llamadas para añadir contexto llamativo a tu contenido" +icon: "info" --- -Los avisos pueden tener estilo de Nota, Advertencia, Información, Consejo, Aprobado, Peligro o puedes crear tu propio aviso: +Las llamadas se pueden presentar como Nota, Advertencia, Info, Consejo, Aprobado, Peligro, o crear tu propia llamada: Esto añade una nota en el contenido @@ -12,16 +12,16 @@ Los avisos pueden tener estilo de Nota, Advertencia, Información, Consejo, Apro Esto añade una nota en el contenido ``` -Esto genera una advertencia que debes tener en cuenta +Esto muestra una advertencia a la que hay que prestar atención ```mdx -Esto genera una advertencia que debes tener en cuenta +Esto genera una advertencia a la que hay que estar atento ``` Esto destaca información importante ```mdx -Destaca información importante +Esto resalta información importante ``` Este es un consejo útil @@ -30,20 +30,20 @@ Los avisos pueden tener estilo de Nota, Advertencia, Información, Consejo, Apro Este es un consejo útil ``` -Esto nos da un estado marcado como verificado +Esto nos da un estado verificado ```mdx Esto nos da un estado verificado ``` -Este es un aviso de advertencia +Este es un aviso de peligro ```mdx -Este es un llamado de atención de peligro +Este es un aviso de peligro ``` - Este es un destacador personalizado + Este es un aviso personalizado ```mdx ajustar -Este es un aviso personalizado +Este es un callout personalizado ``` diff --git a/es/components/cards.mdx b/es/components/cards.mdx index 332b54a3e..a0b081a90 100644 --- a/es/components/cards.mdx +++ b/es/components/cards.mdx @@ -1,31 +1,31 @@ --- title: "Tarjetas" -description: "Destaca puntos clave o enlaces con diseños e íconos personalizables" +description: "Destaca puntos clave o enlaces con diseños e iconos personalizables" icon: "square-mouse-pointer" --- import IconsOptional from "/snippets/es/icons-optional.mdx"; -Usa tarjetas para crear contenedores visuales de contenido. Las tarjetas son contenedores flexibles que pueden incluir texto, íconos, imágenes y enlaces. +Usa tarjetas para crear contenedores visuales de contenido. Las tarjetas son contenedores flexibles que pueden incluir texto, iconos, imágenes y enlaces.
## Tarjeta básica
- Así es como se usa una tarjeta con un ícono y un enlace. Al hacer clic en esta tarjeta, + Así es como usar una tarjeta con un icono y un enlace. Al hacer clic en esta tarjeta, irás a la página Columns. ```mdx Card example - - Así es como se usa una tarjeta con un ícono y un enlace. Al hacer clic en esta tarjeta, - irás a la página Columns. + + Así es como se usa una tarjeta con un ícono y un enlace. Al hacer clic en esta tarjeta + te dirigirá a la página de Columnas. ```
- ## Variaciones de tarjetas + ## Variantes de tarjetas
Las tarjetas ofrecen varias opciones de diseño y estilo para adaptarse a distintas necesidades de contenido. @@ -34,15 +34,15 @@ Las tarjetas ofrecen varias opciones de diseño y estilo para adaptarse a distin ### Diseño horizontal -Añade la propiedad `horizontal` para mostrar tarjetas en un diseño horizontal más compacto. +Agrega la propiedad `horizontal` para mostrar las tarjetas en un diseño horizontal más compacto. Este es un ejemplo de una tarjeta horizontal. ```mdx Horizontal card example - - This is an example of a horizontal card. + + Este es un ejemplo de una tarjeta horizontal. ``` @@ -50,37 +50,37 @@ Añade la propiedad `horizontal` para mostrar tarjetas en un diseño horizontal ### Tarjetas con imagen -Añade la propiedad `img` para mostrar una imagen en la parte superior de la tarjeta. +Agrega la propiedad `img` para mostrar una imagen en la parte superior de la tarjeta. Este es un ejemplo de una tarjeta con imagen. ```mdx Image card example - - This is an example of a card with an image. + + Este es un ejemplo de una tarjeta con imagen. ``` Puedes personalizar el texto de la llamada a la acción y controlar si aparece una flecha. De forma predeterminada, las flechas solo se muestran en los enlaces externos. - - Este es un ejemplo de una tarjeta con un ícono y un enlace. Al hacer clic en esta tarjeta, irás a la página Columns. + + Este es un ejemplo de una tarjeta con un ícono y un enlace. Al hacer clic en esta tarjeta, irás a la página de Columns. ```mdx Link card example - This is an example of a card with an icon and a link. Clicking on this card brings you to the Columns page. + Este es un ejemplo de una tarjeta con un icono y un enlace. Al hacer clic en esta tarjeta te lleva a la página de Columnas. ``` @@ -91,21 +91,21 @@ Puedes personalizar el texto de la llamada a la acción y controlar si aparece u Usa el [componente Columns](/es/components/columns) para organizar varias tarjetas lado a lado. - + Esta es la primera tarjeta. - + Esta es la segunda tarjeta. -```mdx Ejemplo de Columns +```mdx Columns example - + Esta es la primera tarjeta. - + Esta es la segunda tarjeta. @@ -122,19 +122,19 @@ Usa el [componente Columns](/es/components/columns) para organizar varias tarjet - Color del icono como código hexadecimal (p. ej., `#FF6B6B`). + Color del ícono en código hexadecimal (por ejemplo, `#FF6B6B`). - URL a la que navegar cuando se hace clic en la tarjeta. + URL a la que se navega al hacer clic en la tarjeta. - Mostrar la tarjeta en un diseño horizontal compacto. + Muestra la tarjeta en un diseño horizontal compacto. - URL o ruta local de una imagen que se muestra en la parte superior de la tarjeta. + URL o ruta local de una imagen mostrada en la parte superior de la tarjeta. @@ -142,5 +142,5 @@ Usa el [componente Columns](/es/components/columns) para organizar varias tarjet - Mostrar u ocultar el icono de flecha del enlace. - + Mostrar u ocultar el ícono de flecha del enlace. + \ No newline at end of file diff --git a/es/components/code-groups.mdx b/es/components/code-groups.mdx index 4ffc4093a..df6984053 100644 --- a/es/components/code-groups.mdx +++ b/es/components/code-groups.mdx @@ -1,54 +1,52 @@ --- title: "Grupos de código" -description: "Muestra varios ejemplos de código en un mismo componente" +description: "Muestra varios ejemplos de código en un solo componente" icon: "group" --- Usa el componente `CodeGroup` para mostrar varios bloques de código en una interfaz con pestañas, lo que permite a los usuarios comparar implementaciones en distintos lenguajes de programación o ver enfoques alternativos para la misma tarea. - -```javascript helloWorld.js -console.log("Hello World"); -``` - -```python hello_world.py -print('Hello World!') -``` - -```java HelloWorld.java -class HelloWorld { - public static void main(String[] args) { - System.out.println("Hello, World!"); - } -} -``` - + ```javascript helloWorld.js + console.log("Hello World"); + ``` + + ```python hello_world.py + print('Hello World!') + ``` + + ```java HelloWorld.java + class HelloWorld { + public static void main(String[] args) { + System.out.println("Hello, World!"); + } + } + ``` - +Los grupos de código heredan el estilo global de tu archivo `docs.json`. Personaliza tu tema con `styling.codeblocks`. Consulta [Settings](/es/settings#styling) para ver las opciones de configuración.
## Creación de grupos de código
-Para crear un grupo de código, envuelve varios bloques de código con etiquetas ``. Cada bloque de código debe incluir un título, que se usará como etiqueta de pestaña. +Para crear un grupo de código, envuelve varios bloques de código con las etiquetas ``. Cada bloque de código debe incluir un título, que será la etiqueta de la pestaña. ````mdx ```javascript helloWorld.js -console.log("Hello World"); +console.log("Hola Mundo"); ``` ```python hello_world.py -print('Hello World!') +print('¡Hola Mundo!') ``` ```java HelloWorld.java class HelloWorld { public static void main(String[] args) { - System.out.println("Hello, World!"); + System.out.println("¡Hola, Mundo!"); } } ``` @@ -56,49 +54,45 @@ class HelloWorld { ```` - -
## Menú desplegable de idiomas
-Puedes sustituir las pestañas de un grupo de código por un menú desplegable para alternar entre idiomas usando la prop `dropdown`. +Puedes reemplazar las pestañas de un grupo de código por un menú desplegable para alternar entre idiomas usando la prop `dropdown`. - -```javascript helloWorld.js -console.log("Hello World"); -``` - -```python hello_world.py -print('Hello World!') -``` - -```java HelloWorld.java -class HelloWorld { - public static void main(String[] args) { - System.out.println("Hello, World!"); - } -} -``` - + ```javascript helloWorld.js + console.log("Hello World"); + ``` + + ```python hello_world.py + print('Hello World!') + ``` + + ```java HelloWorld.java + class HelloWorld { + public static void main(String[] args) { + System.out.println("Hello, World!"); + } + } + ``` ````mdx highlight=1 ```javascript helloWorld.js -console.log("Hello World"); +console.log("Hola Mundo"); ``` ```python hello_world.py -print('Hello World!') +print('¡Hola Mundo!') ``` ```java HelloWorld.java class HelloWorld { public static void main(String[] args) { - System.out.println("Hello, World!"); + System.out.println("¡Hola, Mundo!"); } } ``` diff --git a/es/components/columns.mdx b/es/components/columns.mdx index fc40cbf3c..517192df0 100644 --- a/es/components/columns.mdx +++ b/es/components/columns.mdx @@ -1,29 +1,29 @@ --- -title: 'Columnas' -description: 'Muestra tarjetas lado a lado en un formato de cuadrícula' +title: 'Columns' +description: 'Muestra tarjetas en paralelo en un formato de cuadrícula' icon: 'columns-2' -keywords: ['grupos de tarjetas'] +keywords: ['card groups'] --- -El componente `Columns` te permite agrupar varios componentes `Card`. Se utiliza con mayor frecuencia para colocar tarjetas en una cuadrícula especificando el número de columnas. +El componente `Columns` te permite agrupar varios componentes `Card`. Se usa principalmente para colocar tarjetas en una cuadrícula especificando el número de columnas. - + Configura tu proyecto con nuestra guía de inicio rápido. - + Explora endpoints, parámetros y ejemplos para tu API. -```mdx Ejemplo de Columns +```mdx Ejemplo de columnas Configura tu proyecto con nuestra guía de inicio rápido. - Explora endpoints, parámetros y ejemplos de tu API. + Explora los endpoints, parámetros y ejemplos de tu API. ``` @@ -34,5 +34,5 @@ El componente `Columns` te permite agrupar varios componentes `Card`. Se utiliza - Número de columnas por fila. + La cantidad de columnas por fila. \ No newline at end of file diff --git a/es/components/examples.mdx b/es/components/examples.mdx index 2aa093c76..9875d167f 100644 --- a/es/components/examples.mdx +++ b/es/components/examples.mdx @@ -11,9 +11,9 @@ Casos de uso comunes: * Documentación de endpoints de API con ejemplos de solicitud y respuesta * Ejemplos de configuración junto con texto explicativo * Fragmentos de código que los usuarios consultan mientras siguen instrucciones -* Ejemplos de “antes y después” en tutoriales +* Ejemplos de antes y después en tutoriales -En dispositivos móviles, los componentes `` y `` se muestran como bloques de código normales y se pueden desplazar. +En dispositivos móviles, los componentes `` y `` se muestran como bloques de código normales y se pueden omitir al desplazarse. ```bash Request @@ -34,7 +34,7 @@ En dispositivos móviles, los componentes `` y `` para anclar ejemplos de código en la barra lateral derecha. Este componente funciona de forma similar al componente [CodeGroup](/es/components/code-groups), pero muestra el código en la barra lateral en lugar de en línea. -Puedes incluir varios bloques de código dentro de un solo ``. Cada bloque de código debe tener un atributo title. +Puedes incluir varios bloques de código dentro de un único ``. Cada bloque de código debe tener un atributo title. ````mdx EjemploDeSolicitud diff --git a/es/components/expandables.mdx b/es/components/expandables.mdx index f446fc928..a70223c8f 100644 --- a/es/components/expandables.mdx +++ b/es/components/expandables.mdx @@ -4,46 +4,43 @@ description: "Alternar para mostrar propiedades anidadas" icon: "list-tree" --- -Usa desplegables para mostrar y ocultar contenido anidado dentro de los campos de respuesta. Los desplegables son especialmente útiles para mostrar propiedades complejas de objetos en la documentación de API. +Usa desplegables para mostrar y ocultar contenido anidado dentro de los campos de respuesta. Los desplegables son especialmente útiles para mostrar propiedades de objetos complejos en la documentación de API. + + El nombre completo del usuario + - - El nombre completo del usuario - - - - Si el usuario tiene más de 21 años - - + + Indica si el usuario es mayor de 21 años + -```mdx Expandable example +```mdx Ejemplo expandible - + El nombre completo del usuario - Si el usuario tiene más de 21 años + Indica si el usuario tiene más de 21 años ``` -
## Propiedades
- El nombre del objeto que se mostrará. + El nombre del objeto que se muestra. - Configúrelo en `true` para que el panel expandible se abra al cargar la página. + Establécelo en `true` para que el panel desplegable se abra al cargar la página. diff --git a/es/components/fields.mdx b/es/components/fields.mdx index 64054b717..5dae7f118 100644 --- a/es/components/fields.mdx +++ b/es/components/fields.mdx @@ -4,13 +4,13 @@ description: "Configura parámetros para tus referencias de API o SDK" icon: "letter-text" --- -Utiliza campos para documentar parámetros y respuestas de la API. Hay dos tipos de campos: de parámetro y de respuesta. +Usa campos para documentar parámetros y respuestas de la API. Hay dos tipos de campos: campos de parámetro y campos de respuesta.
## Campo de parámetro
-El componente `` se utiliza para definir parámetros para tus API o SDK. Al agregar un `ParamField` se añade automáticamente un [Área de pruebas de API](/es/api-playground/overview). +El componente `` se usa para definir parámetros de tus API o SDK. Al agregar un `ParamField`, se añade automáticamente un [Área de pruebas de API](/es/api-playground/overview). Un ejemplo de un campo de parámetro @@ -18,7 +18,7 @@ El componente `` se utiliza para definir parámetros para tus API o ```mdx - Un ejemplo de un campo de parámetro + Un ejemplo de un campo de parámetros ``` @@ -27,7 +27,7 @@ El componente `` se utiliza para definir parámetros para tus API o - Indica si el parámetro es de tipo query, path, body o header. Luego se especifica el + Indica si el parámetro es de consulta, ruta, cuerpo o encabezado. Luego, el nombre del parámetro. @@ -36,7 +36,7 @@ El componente `` se utiliza para definir parámetros para tus API o Admite `number`, `string`, `boolean`, `object`. - Los arreglos se pueden definir usando el sufijo `[]`. Por ejemplo, `string[]`. + Los arreglos pueden definirse usando el sufijo `[]`. Por ejemplo, `string[]`. @@ -48,11 +48,11 @@ El componente `` se utiliza para definir parámetros para tus API o - Valor predeterminado que se establece cuando el valor de la solicitud está vacío + Valor predeterminado que se aplica cuando el valor de la solicitud está vacío. - Texto del placeholder para la entrada en el área de pruebas. + Texto del marcador de posición para el campo en el área de pruebas. @@ -66,12 +66,12 @@ El componente `` se utiliza para definir parámetros para tus API o El componente `` define los valores de retorno de una API. - Un ejemplo de campo de respuesta + Ejemplo de un campo de respuesta ```mdx - Un ejemplo de campo de respuesta + Ejemplo de campo de respuesta ``` @@ -80,23 +80,23 @@ El componente `` define los valores de retorno de una API. - El nombre del valor de respuesta. + El nombre del valor de la respuesta. - Tipo esperado del valor de respuesta. Puede ser cualquier cadena arbitraria. + Tipo esperado del valor de la respuesta. Puede ser cualquier cadena. - El valor predeterminado. + El valor por defecto. - Indica si el campo es obligatorio. + Indica si la respuesta es obligatoria. - Indica si el campo está obsoleto. + Indica si un campo está en desuso. diff --git a/es/components/frames.mdx b/es/components/frames.mdx index db3c2b2b8..6e425e2c8 100644 --- a/es/components/frames.mdx +++ b/es/components/frames.mdx @@ -1,10 +1,10 @@ --- title: "Marcos" -description: "Envuelve imágenes u otros componentes en un contenedor" +description: "Encierra imágenes u otros componentes en un contenedor" icon: "frame" --- -Usa marcos para mostrar imágenes, diagramas u otro contenido visual con un estilo uniforme y leyendas opcionales. Los marcos centran el contenido y aportan separación visual respecto del texto circundante. +Usa marcos para mostrar imágenes, diagramas u otro contenido visual con un estilo uniforme y leyendas opcionales. Los marcos centran el contenido y lo separan visualmente del texto circundante. Fotografía de un lago rodeado de árboles, con montañas a lo lejos en el Parque Nacional de Yellowstone. @@ -14,9 +14,9 @@ Usa marcos para mostrar imágenes, diagramas u otro contenido visual con un esti ## Leyendas -Puedes añadir contexto adicional a una imagen usando la prop opcional `caption`. +Puedes agregar contexto adicional a una imagen usando la prop opcional `caption`. - + Fotografía del valle de Yosemite. @@ -25,7 +25,7 @@ Puedes añadir contexto adicional a una imagen usando la prop opcional `caption` - Texto opcional de leyenda que se muestra centrado debajo de tu componente. + Texto de pie de foto opcional que se muestra centrado debajo de tu componente. diff --git a/es/components/icons.mdx b/es/components/icons.mdx index bbb0a028e..4fd40e23f 100644 --- a/es/components/icons.mdx +++ b/es/components/icons.mdx @@ -1,6 +1,6 @@ --- title: "Iconos" -description: "Usa iconos de bibliotecas populares" +description: "Usa iconos de bibliotecas de iconos populares" icon: "flag" --- @@ -10,26 +10,24 @@ Usa iconos de Font Awesome, Lucide, SVG, URL externas o archivos de tu proyecto -```mdx Icon example +```mdx Ejemplo de icono ``` -
## Iconos en línea
-Los iconos se colocan en línea cuando se usan dentro de un párrafo. +Los iconos se colocan en línea cuando se utilizan dentro de un párrafo. - La documentación que quieres, sin esfuerzo. + La documentación que necesitas, sin esfuerzo. -```markdown Inline icon example - La documentación que quieres, sin esfuerzo. +```markdown Ejemplo de icono en línea + La documentación que quieres, sin complicaciones. ``` -
## Propiedades
@@ -37,9 +35,9 @@ Los iconos se colocan en línea cuando se usan dentro de un párrafo. - El color del ícono como código hexadecimal (por ejemplo, `#FF5733`). + El color del icono como código hexadecimal (por ejemplo, `#FF5733`). - El tamaño del ícono en píxeles. + El tamaño del icono en píxeles. diff --git a/es/components/mermaid-diagrams.mdx b/es/components/mermaid-diagrams.mdx index 384cc3947..afef678c3 100644 --- a/es/components/mermaid-diagrams.mdx +++ b/es/components/mermaid-diagrams.mdx @@ -4,9 +4,9 @@ description: "Muestra diagramas con Mermaid" icon: "waypoints" --- -[Mermaid](https://mermaid.js.org/) te permite crear diagramas de flujo, diagramas de secuencia, diagramas de Gantt y otros diagramas usando texto y código. +[Mermaid](https://mermaid.js.org/) te permite crear diagramas de flujo, de secuencia, de Gantt y otros diagramas usando texto y código. -Para ver la lista completa de tipos de diagramas y su sintaxis admitida, consulta la [documentación de Mermaid](https://mermaid.js.org/intro/). +Para ver la lista completa de tipos de diagramas admitidos y su sintaxis, consulta la [documentación de Mermaid](https://mermaid.js.org/intro/). ```mermaid flowchart LR @@ -20,9 +20,9 @@ Para ver la lista completa de tipos de diagramas y su sintaxis admitida, consult end %% ^ Estos subgrafos son idénticos, excepto por los enlaces que apuntan a ellos: - %% Enlace *a* subgraph1: se mantiene la dirección de subgraph1 + %% Enlace hacia subgraph1: se mantiene la dirección de subgraph1 outside --> subgraph1 - %% Enlace *dentro* de subgraph2: + %% Enlace dentro de subgraph2: %% subgraph2 hereda la dirección del grafo de nivel superior (LR) outside ---> top2 ``` @@ -38,11 +38,11 @@ Para ver la lista completa de tipos de diagramas y su sintaxis admitida, consult direction TB top2[top] --> bottom2[bottom] end - %% ^ Estos subgráficos son idénticos, excepto por los enlaces que apuntan a ellos: + %% ^ Estos subgrafos son idénticos, excepto por los enlaces hacia ellos: - %% Enlace *a* subgraph1: se mantiene la dirección de subgraph1 + %% Enlace al subgraph1: se mantiene la dirección de subgraph1 outside --> subgraph1 - %% Enlace *dentro de* subgraph2: + %% Enlace dentro de subgraph2: %% subgraph2 hereda la dirección del grafo de nivel superior (LR) outside ---> top2 ``` @@ -57,6 +57,6 @@ Para crear un diagrama de Mermaid, escribe la definición del diagrama dentro de ````mdx ```mermaid -// Escribe aquí el código de tu diagrama de Mermaid +// Coloca aquí el código de tu diagrama de Mermaid ``` ```` diff --git a/es/components/panel.mdx b/es/components/panel.mdx index 05ed5b44e..467ba1b78 100644 --- a/es/components/panel.mdx +++ b/es/components/panel.mdx @@ -1,21 +1,21 @@ --- -title: "Panel" -description: "Especifica el contenido del panel lateral derecho" -icon: "panel-right" +title: 'Panel' +description: 'Especifica el contenido del panel lateral derecho' +icon: 'panel-right' --- -Puedes usar el componente `` para personalizar el panel lateral derecho de una página con cualquier componente que quieras. +Puedes usar el componente `` para personalizar el panel lateral derecho de una página con cualquier componente que desees. Si una página incluye un componente ``, los componentes [RequestExample](/es/components/examples#request-example) y [ResponseExample](/es/components/examples#response-example) deben estar dentro de ``. -Los componentes dentro de un `` reemplazarán la tabla de contenidos de la página. +Los componentes dentro de `` reemplazarán la tabla de contenidos de la página. ```mdx - Fija información en el panel lateral. O agrega cualquier otro componente. + Fija la información en el panel lateral. O agrega cualquier otro componente. ``` - Fija información en el panel lateral. O agrega cualquier otro componente. + Fija la información en el panel lateral. O agrega cualquier otro componente. diff --git a/es/components/responses.mdx b/es/components/responses.mdx index 3d0e83a3b..0a40b527f 100644 --- a/es/components/responses.mdx +++ b/es/components/responses.mdx @@ -3,20 +3,19 @@ title: 'Campos de respuesta' description: 'Mostrar valores de respuesta de la API' --- -El componente `` está diseñado para definir los valores de retorno de una API. Muchas docs también usan `` en páginas cuando necesitas enumerar los tipos de algo. +El componente `` está diseñado para definir los valores devueltos por una API. Muchos documentos también utilizan `` en páginas cuando necesitas enumerar los tipos de algo. - Un ejemplo de campo de respuesta + Ejemplo de campo de respuesta ```mdx - Un ejemplo de campo de respuesta + Ejemplo de campo de respuesta ``` -
## Props
@@ -34,11 +33,11 @@ El componente `` está diseñado para definir los valores de reto - Mostrar "required" junto al nombre del campo. + Mostrar “required” junto al nombre del campo. - Indica si un campo está en desuso o no. + Indica si un campo está obsoleto o no. @@ -53,7 +52,7 @@ El componente `` está diseñado para definir los valores de reto ```mdx Response Field Example - Ejemplo de un campo de respuesta + Un ejemplo de campo de respuesta ``` diff --git a/es/components/steps.mdx b/es/components/steps.mdx index bed394ea5..ae09a19a4 100644 --- a/es/components/steps.mdx +++ b/es/components/steps.mdx @@ -1,41 +1,42 @@ --- -title: "Steps" +title: "Pasos" description: "Secuencia contenido con el componente Steps" icon: "list-todo" --- import IconsOptional from "/snippets/es/icons-optional.mdx"; -Usa Steps para mostrar una serie de acciones o eventos secuenciales. Puedes agregar tantos pasos como necesites. +Usa pasos para mostrar una serie de acciones o eventos secuenciales. Puedes agregar tantos pasos como necesites. Estas son instrucciones o contenido que solo aplican al primer paso. + Estas son instrucciones o contenido que solo aplican al segundo paso. + Estas son instrucciones o contenido que solo aplican al tercer paso. -```mdx Steps example +```mdx Ejemplo de pasos - - These are instructions or content that only pertain to the first step. + + Estas son instrucciones o contenido que solo aplican al primer paso. - - These are instructions or content that only pertain to the second step. + + Estas son instrucciones o contenido que solo aplican al segundo paso. - - These are instructions or content that only pertain to the third step. + + Estas son instrucciones o contenido que solo aplican al tercer paso. ``` -
## Propiedades de Steps
@@ -45,17 +46,17 @@ Usa Steps para mostrar una serie de acciones o eventos secuenciales. Puedes agre - El tamaño de los títulos del paso. Puede ser `p`, `h2` o `h3`. + El tamaño de los títulos de los pasos. Puede ser `p`, `h2` o `h3`.
- ## Propiedades individuales del paso + ## Propiedades individuales de un paso
- El contenido de un paso, ya sea texto plano o componentes. + El contenido de un paso, ya sea texto sin formato o componentes. diff --git a/es/components/tabs.mdx b/es/components/tabs.mdx index fa77f0f0a..47075706b 100644 --- a/es/components/tabs.mdx +++ b/es/components/tabs.mdx @@ -1,16 +1,17 @@ --- title: "Pestañas" -description: "Alterna el contenido con el componente Tabs" +description: "Alterna contenido con el componente Tabs" icon: "panel-top" --- -Usa pestañas para organizar contenido en varios paneles entre los que los usuarios pueden cambiar. Puedes agregar tantas pestañas como necesites e incluir otros componentes dentro de cada una. +Usa pestañas para organizar contenido en varios paneles entre los que los usuarios pueden alternar. Puedes añadir tantas pestañas como necesites e incluir otros componentes dentro de cada una. ☝️ Bienvenido al contenido que solo puedes ver dentro de la primera pestaña. - Puedes agregar cualquier número de componentes dentro de las pestañas. Por ejemplo, un bloque de código: + Puedes añadir tantos componentes como quieras dentro de las pestañas. Por ejemplo, un bloque de código: + ```java HelloWorld.java class HelloWorld { public static void main(String[] args) { @@ -19,43 +20,44 @@ Usa pestañas para organizar contenido en varios paneles entre los que los usuar } ``` + - ✌️ Aquí encontrarás contenido que solo aparece dentro de la segunda pestaña. + ✌️ Aquí tienes contenido que solo está dentro de la segunda pestaña. ¡Esta tiene un icono ! + - 💪 Aquí encontrarás contenido que solo aparece dentro de la tercera pestaña. + 💪 Aquí tienes contenido que solo está dentro de la tercera pestaña. -````mdx Tabs example +````mdx Ejemplo de pestañas - - ☝️ Welcome to the content that you can only see inside the first tab. + + ☝️ Bienvenido al contenido que solo puedes ver dentro de la primera pestaña. - You can add any number of components inside of tabs. For example, a code block: + Puedes añadir cualquier cantidad de componentes dentro de las pestañas. Por ejemplo, un bloque de código: ```java HelloWorld.java class HelloWorld { public static void main(String[] args) { - System.out.println("Hello, World!"); + System.out.println("¡Hola, mundo!"); } } ``` - - ✌️ Here's content that's only inside the second tab. + + ✌️ Aquí tienes contenido que solo aparece dentro de la segunda pestaña. - This one has a icon! + ¡Esta tiene un ! - - 💪 Here's content that's only inside the third tab. + + 💪 Aquí tienes contenido que solo aparece dentro de la tercera pestaña. ```` -
## Propiedades
@@ -65,9 +67,9 @@ Usa pestañas para organizar contenido en varios paneles entre los que los usuar - Un icono de [Font Awesome](https://fontawesome.com/icons), un icono de [Lucide](https://lucide.dev/icons), una URL a un icono o una ruta relativa a un icono. + Un ícono de [Font Awesome](https://fontawesome.com/icons), un ícono de [Lucide](https://lucide.dev/icons), una URL a un ícono o una ruta relativa a un ícono. - Solo para iconos de Font Awesome: uno de `regular`, `solid`, `light`, `thin`, `sharp-solid`, `duotone`, `brands`. + Solo para íconos de Font Awesome: uno de `regular`, `solid`, `light`, `thin`, `sharp-solid`, `duotone`, `brands`. diff --git a/es/components/tooltips.mdx b/es/components/tooltips.mdx index 48b0621ad..3954173da 100644 --- a/es/components/tooltips.mdx +++ b/es/components/tooltips.mdx @@ -4,12 +4,12 @@ description: "Muestra una definición al pasar el cursor sobre el texto" icon: "message-square" --- -Usa los tooltips para proporcionar contexto adicional o definiciones cuando un usuario pasa el cursor sobre un fragmento de texto. Los tooltips pueden incluir enlaces opcionales con llamadas a la acción. +Usa tooltips para proporcionar contexto adicional o definiciones cuando un usuario pasa el cursor sobre un fragmento de texto. Los tooltips pueden incluir enlaces opcionales con llamada a la acción. -**Ejemplo**: API La documentación ayuda a los desarrolladores a entender cómo integrarse con tu servicio. +**Ejemplo**: API La documentación ayuda a los desarrolladores a entender cómo integrarse con tu servicio. -```mdx Ejemplo de ajuste de tooltip -La documentación de la API ayuda a los desarrolladores a entender cómo integrarse con tu servicio. +```mdx Envoltura de ejemplo de tooltip +API la documentación ayuda a los desarrolladores a entender cómo integrarse con tu servicio. ```
@@ -17,13 +17,13 @@ Usa los tooltips para proporcionar contexto adicional o definiciones cuando un u
- El texto que se muestra en el globo de ayuda. + El texto que se muestra en el indicador (tooltip). - El texto del llamado a la acción para un enlace dentro del globo de ayuda. + El texto del llamado a la acción para un enlace dentro del indicador (tooltip). - URL del enlace del llamado a la acción. Obligatorio cuando se utiliza `cta`. + URL del enlace del llamado a la acción. Obligatorio cuando se usa `cta`. \ No newline at end of file diff --git a/es/components/update.mdx b/es/components/update.mdx index 9bb85e5ce..34395d0c8 100644 --- a/es/components/update.mdx +++ b/es/components/update.mdx @@ -1,10 +1,10 @@ --- title: "Actualización" -description: "Sigue los cambios y actualizaciones" +description: "Lleva un registro de cambios y actualizaciones" icon: "list-collapse" --- -Usa el componente `Update` para mostrar entradas del registro de cambios, actualizaciones de versión y notas de lanzamiento con un formato coherente. +Usa el componente `Update` para mostrar entradas del registro de cambios, actualizaciones de versiones y notas de lanzamiento con un formato uniforme. ## Actualización de ejemplo @@ -23,10 +23,10 @@ Usa el componente `Update` para mostrar entradas del registro de cambios, actual
- ## Cómo usar + ## Cómo usarlo
-```mdx Update example +```mdx Ejemplo de actualización Esta es una actualización con una etiqueta, una descripción y una etiqueta. @@ -39,7 +39,7 @@ Usa varios componentes `Update` para crear [registros de cambios](/es/guides/cha - Etiqueta de la actualización. Aparece a la izquierda de la actualización y crea un enlace ancla. Las etiquetas deben ser únicas. + Etiqueta de la actualización. Aparece a la izquierda de la actualización y genera un enlace de anclaje. Las etiquetas deben ser únicas. diff --git a/es/contact-support.mdx b/es/contact-support.mdx index 0ed6a96bd..2bec8b089 100644 --- a/es/contact-support.mdx +++ b/es/contact-support.mdx @@ -1,14 +1,14 @@ --- -title: "Contactar con soporte" +title: "Contactar al soporte" icon: "circle-help" -description: "Estamos aquí para ayudarte a sacar el máximo partido a Mintlify" +description: "Estamos aquí para ayudarte a sacarle el máximo provecho a Mintlify" ---
- ## Consulta nuestra documentación + ## Pregunta a nuestra documentación
-Selecciona Command + I para iniciar un chat con nuestro Asistente de IA entrenado con nuestra documentación. +Selecciona Command + I para iniciar un chat con nuestro Asistente entrenado con nuestra documentación.
## Mira tutoriales en video @@ -17,19 +17,19 @@ Selecciona Command + I para iniciar un chat con nuestro As Visita nuestro canal de [YouTube](https://www.youtube.com/@GetMintlify/videos) para encontrar tutoriales y guías sobre el uso de Mintlify.
- ## Soporte por mensaje + ## Soporte por mensajes
Envíanos un mensaje desde tu [panel](https://dashboard.mintlify.com/) seleccionando **Support** en la barra lateral. -![GIF que muestra cómo acceder al soporte desde el panel al seleccionar el botón Support, luego elegir una opción y escribir una pregunta en la ventana modal de soporte que aparece.](https://mintlify.s3.us-west-1.amazonaws.com/mintlify/images/support-flow.gif) +![GIF que muestra cómo acceder al soporte desde el panel: seleccionar el botón Support, luego una opción y escribir una pregunta en el modal de soporte que aparece.](https://mintlify.s3.us-west-1.amazonaws.com/mintlify/images/support-flow.gif) -Nuestro objetivo es responder a todas las solicitudes en un plazo de 24 horas, pero pueden producirse demoras en períodos de alta demanda. +Nuestro objetivo es responder a todas las solicitudes en un plazo de 24 horas, pero pueden producirse retrasos en períodos de alta demanda.
## Soporte por correo electrónico
-Si no puedes acceder a tu panel, escríbenos a support@mintlify.com. \ No newline at end of file +Si no puedes acceder al panel, envíanos un correo a support@mintlify.com. \ No newline at end of file diff --git a/es/editor/branches.mdx b/es/editor/branches.mdx index 0383ce827..c327fa05d 100644 --- a/es/editor/branches.mdx +++ b/es/editor/branches.mdx @@ -1,42 +1,42 @@ --- title: "Trabajo con ramas" -description: "Usa ramas para realizar y revisar cambios sin afectar tu documentación publicada" +description: "Usa ramas para realizar y revisar cambios sin afectar tu documentación en producción" --- -Las ramas son una función del control de versiones que señalan commits específicos en tu repositorio. Tu rama de despliegue, normalmente llamada `main`, representa el contenido con el que se construye tu documentación publicada. Todas las demás ramas son independientes de tu documentación en producción, a menos que decidas fusionarlas en tu rama de despliegue. +Las ramas son una característica del control de versiones que apuntan a commits específicos en tu repositorio. Tu rama de despliegue, generalmente llamada `main`, representa el contenido con el que se construye tu documentación en producción. Todas las demás ramas son independientes de tu documentación en producción, a menos que decidas fusionarlas con tu rama de despliegue. -Las ramas te permiten crear instancias separadas de tu documentación para realizar cambios, solicitar revisiones y probar nuevos enfoques antes de publicar. Tu equipo puede trabajar en ramas para actualizar diferentes partes de la documentación al mismo tiempo sin afectar lo que ven los usuarios en el sitio en producción hasta que publiques los cambios. +Las ramas te permiten crear instancias separadas de tu documentación para hacer cambios, solicitar revisiones y probar nuevos enfoques antes de publicar. Tu equipo puede trabajar en ramas para actualizar distintas partes de la documentación al mismo tiempo sin afectar lo que los usuarios ven en tu sitio en producción hasta que publiques los cambios. -Recomendamos trabajar siempre con ramas al actualizar la documentación para mantener estable el sitio en producción y habilitar flujos de trabajo de revisión. +Recomendamos trabajar siempre con ramas al actualizar la documentación para mantener estable tu sitio en producción y habilitar flujos de revisión. - - Nombra las ramas de forma clara para que tus compañeros entiendan en qué estás trabajando. + - Pon nombres claros a las ramas para que tus compañeros entiendan en qué estás trabajando. - Elimina las ramas después de fusionarlas para mantener organizado tu repositorio. - - Informa a tu equipo cuando trabajes en cambios importantes que puedan afectar su trabajo. + - Informa a tu equipo cuando estés trabajando en cambios importantes que puedan afectar su trabajo.
## Crear una rama
-1. Selecciona el nombre de la rama en la barra de herramientas del editor (normalmente `main` de forma predeterminada). +1. Selecciona el nombre de la rama en la barra de herramientas del editor (generalmente `main` de forma predeterminada). 2. Selecciona **New Branch**. -3. Ingresa un nombre descriptivo para tu rama, como `update-getting-started` o `fix-api-examples`. +3. Escribe un nombre descriptivo para la rama, como `update-getting-started` o `fix-api-examples`. 4. Selecciona **Create Branch**.
## Guardar cambios en una rama
-Para guardar los cambios en una rama, selecciona el botón **Save Changes** en la esquina superior derecha del editor. Esto crea un commit y envía tu trabajo a tu rama. +Para guardar tus cambios en una rama, selecciona el botón **Save Changes** en la esquina superior derecha del editor. Esto crea un commit y envía tu trabajo a tu rama.
## Cambiar de rama
1. Selecciona el nombre de la rama en la barra de herramientas del editor. -2. Selecciona en el menú desplegable la rama a la que quieres cambiar. +2. Selecciona la rama a la que quieres cambiar en el menú desplegable. - Los cambios sin guardar se perderán al cambiar de rama. Asegúrate de guardar o publicar tu trabajo antes de cambiar de rama. + Los cambios no guardados se perderán al cambiar de rama. Asegúrate de guardar o publicar tu trabajo antes de cambiar de rama. \ No newline at end of file diff --git a/es/editor/content-management.mdx b/es/editor/content-management.mdx index be837ecfa..f33cf1595 100644 --- a/es/editor/content-management.mdx +++ b/es/editor/content-management.mdx @@ -1,15 +1,15 @@ --- -title: "Administración de contenido" +title: "Gestión del contenido" description: "Crea, edita y organiza tus páginas de documentación" --- -Usa el explorador de archivos de la barra lateral para navegar por tus archivos de documentación. Haz clic en cualquier archivo para abrirlo en el editor. +Usa el explorador de archivos de la barra lateral para recorrer tus archivos de documentación. Haz clic en cualquier archivo para abrirlo en el editor. -Pulsa Command + P (Ctrl + P en Windows) para buscar archivos por nombre. +Presiona Command + P (Ctrl + P en Windows) para buscar archivos por nombre.
## Crear nuevas páginas @@ -40,25 +40,25 @@ Pulsa Command + P (Ctrl + P en Windo Los nombres de archivo deben terminar en `.mdx`. Por ejemplo, `api-reference.mdx` o `getting-started.mdx`. - Presiona Enter para crear el archivo. Se abrirá automáticamente en el editor, listo para agregar contenido. + Pulsa Enter para crear el archivo. Se abrirá automáticamente en el editor, listo para añadir contenido.
- ## Organiza tu navegación + ## Organiza la navegación
-Añade nuevas páginas a la navegación de tu sitio editando el archivo `docs.json`. +Agrega nuevas páginas a la navegación de tu sitio editando el archivo `docs.json`. - + Busca y abre el archivo `docs.json` en el directorio raíz usando el explorador de archivos. - - Ubica la sección del archivo `docs.json` donde quieres añadir la nueva página. + + Encuentra el lugar en el archivo `docs.json` donde quieres agregar la nueva página. - - Inserta el nombre de archivo de la página (sin la extensión `.mdx`) en el array `pages` del grupo correspondiente. + + Inserta el nombre de archivo de la página (sin la extensión `.mdx`) en el arreglo `pages` del grupo correspondiente. @@ -97,19 +97,19 @@ Añade nuevas páginas a la navegación de tu sitio editando el archivo `docs.js ## Edición de contenido
-Haz cambios en tus páginas usando el modo visual o el modo Markdown en el editor. +Realiza cambios en tus páginas usando el modo visual o el modo Markdown en el editor. En el modo visual, presiona / para abrir el menú de componentes. Agrega bloques de contenido, avisos, bloques de código y otros componentes para personalizar tu documentación. El menú de componentes desplegado resaltado en el editor web de Mintlify El menú de componentes desplegado resaltado en el editor web de Mintlify diff --git a/es/editor/getting-started.mdx b/es/editor/getting-started.mdx index 25f634fd4..b041ab7a4 100644 --- a/es/editor/getting-started.mdx +++ b/es/editor/getting-started.mdx @@ -10,37 +10,37 @@ description: "Aprende a crear y editar documentación con el editor web" El editor web es una interfaz visual para crear, editar y revisar documentación directamente en tu navegador. -* **Edición visual**: Realiza cambios en tu documentación usando un editor WYSIWYG (lo que ves es lo que obtienes) que muestra cómo se verá tu contenido al publicarse. +* **Edición visual**: Realiza cambios en tu documentación con un editor WYSIWYG (lo que ves es lo que obtienes) que muestra cómo se verá tu contenido al publicarse. * **Sincronización con Git**: Todos los cambios se sincronizan automáticamente con tu repositorio de Git para mantener el control de versiones. * **Colaboración en equipo**: Varias personas pueden trabajar en la documentación simultáneamente. -* **Integración de componentes**: Agrega notas, bloques de código y otros componentes con comandos de barra. +* **Integración de componentes**: Agrega avisos, bloques de código y otros componentes con comandos de barra inclinada. * **Sin configuración**: Comienza a escribir de inmediato desde tu panel.
- ## Flujo de trabajo del editor web + ## Flujo de trabajo del Editor web
-Así es como normalmente trabajarás en el editor web: +Así es como normalmente trabajarás en el Editor web: - Crea una rama o realiza cambios directamente en la rama de despliegue. Recomendamos crear una rama para poder previsualizar los cambios antes de publicarlos. + Crea una rama o realiza cambios directamente en tu rama de despliegue. Recomendamos crear una rama para que puedas previsualizar tus cambios antes de que se publiquen. - Ve a un archivo existente en la barra lateral o crea uno nuevo con el explorador de archivos. + Navega a un archivo existente en la barra lateral o crea uno nuevo con el explorador de archivos. - Realiza cambios en el editor web. Prueba alternar entre el modo visual y el modo Markdown con el conmutador de la esquina superior derecha para ver qué modo prefieres. + Realiza cambios en el Editor web. Prueba alternar entre el modo visual y el modo Markdown usando el interruptor en la esquina superior derecha para ver qué modo prefieres. - El modo visual muestra cómo se verán tus cambios en el sitio en producción. Úsalo para verificar que todo se vea correcto. + El modo visual te muestra cómo aparecerán tus cambios en tu sitio en producción. Úsalo para verificar que todo se vea correcto. - Si estás trabajando en la rama de despliegue, publica los cambios directamente desde el editor web. En otras ramas, crea una pull request para revisión antes de publicar. + Si estás trabajando en tu rama de despliegue, publica tus cambios directamente desde el Editor web. En otras ramas, crea una pull request para revisión antes de publicar. @@ -48,7 +48,7 @@ Así es como normalmente trabajarás en el editor web: ## Modos del editor
-El editor web tiene dos modos para adaptarse a distintas preferencias y necesidades de edición. Usa el conmutador en la esquina superior derecha de la barra de herramientas del editor para cambiar entre modos de edición. +El editor web tiene dos modos para adaptarse a distintas preferencias y necesidades de edición. Usa el conmutador en la esquina superior derecha de la barra de herramientas del editor para cambiar entre los modos de edición. Iconos del conmutador de modo resaltados en el editor web. @@ -60,7 +60,7 @@ El editor web tiene dos modos para adaptarse a distintas preferencias y necesida ### Modo visual -El modo visual ofrece una experiencia WYSIWYG en la que los cambios que realices en el editor serán los que se publiquen en tu sitio de documentación. Este modo es ideal cuando quieres ver en tiempo real cómo se verán tus cambios. +El modo visual ofrece una experiencia WYSIWYG en la que los cambios que hagas en el editor son los que se publicarán en tu sitio de documentación. Este modo es ideal cuando quieres ver en tiempo real cómo se verán tus cambios. Pulsa `/` para abrir el menú de componentes y añadir contenido con estilo, avisos, fragmentos de código u otros componentes. @@ -74,12 +74,12 @@ Pulsa `/` para abrir el menú de componentes y añadir contenido con estilo, avi ### Modo Markdown -El modo Markdown ofrece acceso directo al código `MDX` subyacente de tu documentación. Este modo es ideal cuando necesitas un control preciso de las propiedades de los componentes o cuando prefieres escribir con sintaxis Markdown. +El modo Markdown ofrece acceso directo al código `MDX` subyacente de tu documentación. Este modo es ideal cuando necesitas un control preciso sobre las propiedades de los componentes o cuando prefieres escribir con la sintaxis de Markdown. - Modo Markdown en el editor web de Mintlify + Modo Markdown en el Editor web de Mintlify - Modo Markdown en el editor web de Mintlify + Modo Markdown en el Editor web de Mintlify
@@ -87,6 +87,6 @@ El modo Markdown ofrece acceso directo al código `MDX` subyacente de tu documen
* Aprende los conceptos fundamentales de [Git](/es/editor/git-concepts). -* Aprende las prácticas recomendadas para colaborar con [ramas](/es/editor/branches). -* Explora la [gestión de contenido](/es/editor/content-management) con el editor web. +* Conoce las prácticas recomendadas para colaborar con [ramas](/es/editor/branches). +* Explora la [gestión de contenido](/es/editor/content-management) con el Editor web. * Comprende las [opciones de publicación](/es/editor/publishing) para distintos escenarios. \ No newline at end of file diff --git a/es/editor/git-concepts.mdx b/es/editor/git-concepts.mdx index 5439f2a16..bb46ee9dd 100644 --- a/es/editor/git-concepts.mdx +++ b/es/editor/git-concepts.mdx @@ -1,19 +1,19 @@ --- title: "Conceptos de Git" -description: "Aprende los fundamentos de Git para el flujo de trabajo de docs-as-code" +description: "Aprende los fundamentos de Git para el flujo de trabajo de documentación como código" --- -Git es un sistema de control de versiones que te permite realizar un seguimiento de los cambios en tu documentación y colaborar con los miembros del equipo. Con Git, para cada archivo de tu proyecto puedes ver qué cambió, cuándo y por qué. Git también facilita volver a versiones anteriores de los archivos si alguna vez lo necesitas. +Git es un sistema de control de versiones que te permite realizar un seguimiento de los cambios en tu documentación y colaborar con tu equipo. Con Git, para cada archivo de tu proyecto puedes ver qué cambió, cuándo y por qué. Git también facilita volver a versiones anteriores de los archivos cuando lo necesites. -El editor web realiza algunas operaciones de Git en segundo plano. Comprender estos conceptos te ayudará a trabajar de forma más efectiva con el editor web y a colaborar con los miembros del equipo que trabajan en sus entornos de desarrollo locales. +El editor web realiza algunas operaciones de Git en segundo plano. Entender estos conceptos te ayudará a trabajar de forma más eficaz con el editor web y a colaborar con miembros del equipo que trabajan en sus entornos de desarrollo locales.
- ## Conceptos clave de Git + ## Conceptos básicos de Git
- El origen de tu documentación, donde se almacenan todos los archivos y su historial. El Editor web se conecta a tu repositorio para acceder al contenido y modificarlo. + El origen de tu documentación, donde se almacenan todos los archivos y su historial. El Editor web se conecta a tu repositorio para acceder y modificar el contenido. @@ -21,38 +21,38 @@ El editor web realiza algunas operaciones de Git en segundo plano. Comprender es - Una rama apunta a un commit específico en tu repositorio. Tu documentación en producción se construye a partir de una rama de despliegue. Puedes tener cualquier número de otras ramas con cambios que aún no se han publicado en tu documentación en producción. Si quieres incorporar los cambios de una rama a tu documentación en producción, puedes fusionarla en tu rama de despliegue mediante una pull request. + Una rama apunta a un commit específico en tu repositorio. Tu documentación en producción se genera a partir de una rama de implementación. Puedes tener cualquier número de otras ramas con cambios que aún no se han publicado en tu documentación en producción. Si quieres incorporar los cambios de una rama en tu documentación en producción, puedes fusionarla en tu rama de implementación mediante una pull request. Usa ramas para trabajar en cambios sin afectar tu documentación en producción, experimentar de forma segura con nuevas funciones y obtener revisiones antes de publicar. - La rama principal de tu proyecto desde la cual se construye el contenido de tu documentación en producción. Los cambios en esta rama se publican automáticamente en tu sitio de documentación. A menudo se llama `main`, pero puedes establecer cualquier rama como tu rama de despliegue. + La rama principal de tu proyecto a partir de la cual se genera el contenido de tu documentación en producción. Los cambios en esta rama se publican automáticamente en tu sitio de documentación. A menudo se llama `main`, pero puedes establecer cualquier rama como tu rama de implementación. - Una forma de proponer fusionar tus cambios en una rama con tu documentación en producción. Permite revisión y debate antes de que los cambios se publiquen. Comúnmente llamada PR, y también llamada merge request en GitLab. + Una forma de proponer fusionar los cambios de una rama en tu documentación en producción. Permite revisar y debatir antes de que los cambios se publiquen. Se conoce comúnmente como PR y, en GitLab, como merge request. - Un diff (o diferencia) muestra los cambios entre dos versiones de un archivo. Al revisar pull requests, los diffs resaltan lo que se ha añadido, eliminado o modificado, lo que facilita identificar qué cambió. + Un diff (o diferencia) muestra los cambios entre dos versiones de un archivo. Al revisar pull requests, los diffs resaltan lo que se ha agregado, eliminado o modificado, lo que facilita identificar qué cambió.
- ## Cómo el editor web utiliza Git + ## Cómo utiliza Git el editor web
-El editor web se conecta a tu repositorio de Git mediante la [aplicación de GitHub](/es/settings/github) o la [integración de GitLab](/es/settings/gitlab) y automatiza operaciones comunes de Git. +El editor web se conecta a tu repositorio de Git a través de la [GitHub App](/es/settings/github) o la [integración con GitLab](/es/settings/gitlab) y automatiza operaciones comunes de Git. Cuando: -* **Abres un archivo**: el editor obtiene la versión más reciente de tu repositorio, asegurando que siempre trabajes con contenido actualizado. -* **Realizas cambios**: el editor registra tus cambios como un borrador que puede convertirse en un commit cuando estés listo para guardar tu trabajo. -* **Guardas los cambios**: el editor crea un commit con tus cambios, preservando tu trabajo en el historial del proyecto. -* **Creas una rama**: el editor crea una nueva rama en tu repositorio que puede ser utilizada por cualquier persona con acceso para colaborar y revisar cambios. -* **Publicas en tu rama de despliegue**: el editor hace commit y push directamente a tu rama de despliegue, lo que publica tus cambios de inmediato. -* **Publicas en otras ramas**: el editor crea una pull request, lo que te permite recibir comentarios de otros antes de fusionar tus cambios en tu rama de despliegue. +* **Abres un archivo**: El editor obtiene la versión más reciente de tu repositorio, garantizando que siempre trabajes con contenido actualizado. +* **Realizas cambios**: El editor registra tus cambios como un borrador que puede convertirse en un commit cuando estés listo para guardar tu trabajo. +* **Guardas cambios**: El editor crea un commit con tus cambios, preservando tu trabajo en el historial del proyecto. +* **Creas una rama**: El editor crea una nueva rama en tu repositorio que puede ser utilizada por cualquier persona con acceso al repositorio para colaborar y revisar los cambios. +* **Publicas en tu rama de despliegue**: El editor hace commit y push directamente a tu rama de despliegue, lo que publica tus cambios de inmediato. +* **Publicas en otras ramas**: El editor crea una pull request, lo que te permite recibir comentarios de otros antes de fusionar tus cambios en tu rama de despliegue.
## Mejores prácticas de Git @@ -60,7 +60,7 @@ Cuando: Cada equipo desarrollará sus propios flujos de trabajo y preferencias, pero estas son algunas prácticas generales para empezar. -* **Escribe mensajes de commit descriptivos**: Sé específico respecto a qué cambió y utiliza un lenguaje activo. -* **Usa nombres de ramas descriptivos**: Los nombres de las ramas deben explicar el trabajo que se está realizando y ser claros para quien mire las ramas en tu repositorio. -* **Mantén las ramas enfocadas**: Limita los cambios de una rama a una tarea o proyecto específico. -* **Elimina las ramas después de fusionarlas**: Elimina las ramas cuando ya no las necesites para mantener tu repositorio ordenado. \ No newline at end of file +* **Escribe mensajes de commit descriptivos**: Sé específico sobre qué cambió y utiliza un lenguaje activo. +* **Usa nombres de rama descriptivos**: Los nombres de las ramas deben explicar el trabajo que se está realizando y ser significativos para quien las consulte en tu repositorio. +* **Mantén las ramas enfocadas**: Limita los cambios en una rama a una tarea o proyecto específico. +* **Elimina las ramas después de hacer merge**: Borra las ramas cuando ya no las necesites para mantener tu repositorio ordenado. \ No newline at end of file diff --git a/es/editor/keyboard-shortcuts.mdx b/es/editor/keyboard-shortcuts.mdx index f1b8086f4..df5ee8981 100644 --- a/es/editor/keyboard-shortcuts.mdx +++ b/es/editor/keyboard-shortcuts.mdx @@ -1,14 +1,14 @@ --- title: "Atajos de teclado" -description: "Atajos para el editor web" +description: "Atajos del editor web" --- -El editor web admite los atajos de teclado comunes como copiar, pegar, deshacer y seleccionar todo, además de los siguientes: +El editor web admite todos los atajos de teclado habituales, como copiar, pegar, deshacer y seleccionar todo, además de los siguientes: | Comando | macOS | Windows | |:--------|:------|:--------| | **Buscar archivos** | Cmd + P | Control + P | -| **Agregar enlace al texto seleccionado** | Cmd + K | Control + K | +| **Añadir enlace al texto seleccionado** | Cmd + K | Control + K | | **Insertar salto de línea** | Cmd + Enter | Control + Enter | | **Negrita** | Cmd + B | Control + B | | **Cursiva** | Cmd + I | Control + I | @@ -22,6 +22,6 @@ El editor web admite los atajos de teclado comunes como copiar, pegar, deshacer | **Encabezado 4** | Cmd + Alt + 4 | Control + Alt + 4 | | **Lista numerada** | Cmd + Shift + 7 | Control + Shift + 7 | | **Lista con viñetas** | Cmd + Shift + 8 | Control + Shift + 8 | -| **Cita** | Cmd + Shift + B | Control + Shift + B | +| **Cita en bloque** | Cmd + Shift + B | Control + Shift + B | | **Subíndice** | Cmd + , | Control + , | | **Superíndice** | Cmd + . | Control + . | \ No newline at end of file diff --git a/es/editor/publishing.mdx b/es/editor/publishing.mdx index 4bf7b16fa..20772945a 100644 --- a/es/editor/publishing.mdx +++ b/es/editor/publishing.mdx @@ -1,12 +1,12 @@ --- -title: "Publicar tus cambios" +title: "Publicación de tus cambios" description: "Despliega las actualizaciones de tu documentación directamente a producción o mediante pull requests" --- Cómo se publiquen tus cambios depende de la rama en la que estés trabajando: -* **Rama de despliegue**: Al publicar, tu sitio en producción se actualiza de inmediato. -* **Otras ramas**: Al publicar, se crea un pull request para que puedas revisar los cambios antes de que se desplieguen a producción. +* **Rama de despliegue**: Publicar actualiza tu sitio en producción de inmediato. +* **Otras ramas**: Publicar crea un pull request para que puedas revisar los cambios antes de desplegarlos en producción. -Los pull requests te permiten proponer cambios desde tu rama para que otras personas los revisen antes de integrarlos en tu documentación publicada. Esto ayuda a asegurar que tus cambios sean correctos y le da a tu equipo la oportunidad de colaborar en el contenido. +Los pull requests te permiten proponer cambios desde tu rama para que otras personas los revisen antes de integrarlos en tu documentación en producción. Esto ayuda a garantizar que tus cambios sean correctos y le da a tu equipo la oportunidad de colaborar en el contenido. - Incluso si trabajas en solitario, los pull requests son útiles para previsualizar cambios y mantener un historial claro de actualizaciones. + Incluso si trabajas solo, los pull requests son útiles para previsualizar cambios y mantener un historial claro de actualizaciones.
@@ -44,12 +44,12 @@ Los pull requests te permiten proponer cambios desde tu rama para que otras pers Escribe un título y una descripción claros que expliquen: - - Qué cambios hiciste + - Qué cambios realizaste - Por qué los hiciste - Cualquier área específica que necesite revisión - Selecciona **Publish Pull Request**. El editor te proporcionará un enlace para ver tu pull request. + Selecciona **Publish Pull Request**. El editor proporcionará un enlace para ver tu pull request. -Una vez creado tu pull request: +Una vez creado el pull request: 1. **Revisar cambios**: Tú y tu equipo pueden revisar el pull request en tu proveedor de Git, como GitHub o GitLab. 2. **Dejar comentarios**: Agrega comentarios o solicita cambios. -3. **Hacer cambios adicionales**: Realiza cambios adicionales en el editor web. Al guardar, el editor los envía a tu pull request. +3. **Hacer cambios adicionales**: Realiza cambios adicionales en el Editor web. Al guardar, el editor los envía a tu pull request. 4. **Aprobar**: Aprueba el pull request cuando estés satisfecho con los cambios. 5. **Fusionar**: Fusiona el pull request cuando estés listo para desplegar tus cambios a producción. \ No newline at end of file diff --git a/es/editor/troubleshooting.mdx b/es/editor/troubleshooting.mdx index 356467240..e692f1323 100644 --- a/es/editor/troubleshooting.mdx +++ b/es/editor/troubleshooting.mdx @@ -4,7 +4,7 @@ sidebarTitle: "Solución de problemas" description: "Soluciones a problemas comunes" --- -Encuentra soluciones a problemas comunes que podrías encontrar al usar el editor web. +Encuentra soluciones a problemas comunes que puedes encontrar al usar el editor web. @@ -12,13 +12,13 @@ Encuentra soluciones a problemas comunes que podrías encontrar al usar el edito * El despliegue aún está en curso * Problemas de caché del navegador - * Errores de compilación o despliegue + * Errores de compilación o de despliegue **Soluciones:** 1. Revisa el estado del despliegue en tu panel. - 2. Fuerza la recarga del navegador (Ctrl + F5 o Cmd + Shift + R) - 3. Borra la caché del navegador. + 2. Actualiza forzosamente tu navegador (Ctrl + F5 o Cmd + Shift + R) + 3. Borra la caché de tu navegador. @@ -30,7 +30,7 @@ Encuentra soluciones a problemas comunes que podrías encontrar al usar el edito **Soluciones:** 1. Verifica que tengas el acceso adecuado al repositorio. - 2. Comprueba que tu integración con Git esté configurada correctamente. + 2. Comprueba si tu integración con Git está configurada correctamente. 3. Revisa la documentación de [Permisos del editor](/es/advanced/dashboard/permissions). @@ -42,7 +42,7 @@ Encuentra soluciones a problemas comunes que podrías encontrar al usar el edito **Soluciones:** - 1. Verifica tu conexión a internet. + 1. Verifica tu conexión a Internet. 2. Actualiza la página. 3. Contacta con soporte si el problema persiste. @@ -52,11 +52,11 @@ Encuentra soluciones a problemas comunes que podrías encontrar al usar el edito * Sintaxis MDX no válida en los archivos * Archivos faltantes o dañados - * Archivos de gran tamaño que causan tiempos de espera + * Archivos de gran tamaño que provocan tiempos de espera **Soluciones:** - 1. Revisa la sintaxis del archivo para detectar errores de formato en MDX. + 1. Revisa la sintaxis del archivo para detectar errores de formato MDX. 2. Verifica que el archivo exista en tu repositorio. \ No newline at end of file diff --git a/es/guides/assistant.mdx b/es/guides/assistant.mdx index ec257e0fc..7c0ebd984 100644 --- a/es/guides/assistant.mdx +++ b/es/guides/assistant.mdx @@ -1,6 +1,6 @@ --- title: "Asistente" -description: "Ayuda a tus usuarios a aprovechar tu producto y a encontrar respuestas más rápido" +description: "Ayuda a los usuarios a sacar el máximo partido de tu producto y a encontrar respuestas más rápido" icon: "bot" --- @@ -12,27 +12,27 @@ icon: "bot" ## Acerca del asistente
-El asistente responde preguntas sobre tu documentación mediante consultas en lenguaje natural. Está integrado directamente en tu sitio de documentación, ofreciendo a los usuarios acceso inmediato a ayuda contextual. +El Asistente responde preguntas sobre tu documentación mediante consultas en lenguaje natural. Está integrado directamente en tu sitio de documentación, brindando a los usuarios acceso inmediato a ayuda contextual. -El asistente utiliza RAG agentivo (generación aumentada por recuperación) con llamadas a herramientas, impulsado por Claude Sonnet 4. Cuando los usuarios hacen preguntas, el asistente: +El Asistente utiliza RAG agentivo (generación aumentada por recuperación) con llamadas a herramientas, impulsado por Claude Sonnet 4. Cuando los usuarios hacen preguntas, el Asistente: * **Busca y recupera** contenido relevante de tu documentación para ofrecer respuestas precisas. * **Cita las fuentes** y proporciona enlaces navegables que llevan a los usuarios directamente a las páginas de referencia. -* **Genera ejemplos de código que se pueden copiar** para ayudar a los usuarios a implementar soluciones a partir de tu documentación. +* **Genera ejemplos de código para copiar** que ayudan a los usuarios a implementar soluciones a partir de tu documentación. -Cada mensaje enviado al asistente cuenta para la cuota de mensajes de tu plan. Si superas tu cuota, los mensajes adicionales generarán cargos por excedente. Puedes establecer límites de gasto o desactivar el asistente si alcanzas tu cuota de mensajes. +Cada mensaje enviado al Asistente cuenta para el cupo de mensajes de tu plan. Si superas tu cupo, los mensajes adicionales generarán cargos por excedente. Puedes establecer límites de gasto o desactivar el Asistente si alcanzas tu cupo de mensajes. -Puedes ver el uso del asistente en tu panel para comprender el comportamiento de los usuarios y la efectividad de la documentación. Exporta y analiza los datos de consultas para ayudar a identificar: +Puedes ver el uso del Asistente en tu panel para comprender el comportamiento de los usuarios y la efectividad de la documentación. Exporta y analiza los datos de las consultas para ayudar a identificar: * Preguntas frecuentes que podrían necesitar mejor cobertura. -* Brechas de contenido donde los usuarios tienen dificultades para encontrar respuestas. +* Vacíos de contenido donde los usuarios tienen dificultades para encontrar respuestas. * Temas populares que podrían beneficiarse de contenido adicional.
- ## Configuración del Asistente + ## Configuración del asistente
-El Asistente está habilitado de forma predeterminada para los planes Pro y Custom. Puedes gestionarlo desde tu [panel](https://dashboard.mintlify.com/products/assistant/settings), incluyendo habilitarlo o deshabilitarlo, configurar el manejo de respuestas y establecer un límite de gasto. +El Asistente está habilitado de forma predeterminada para los planes Pro y Custom. Puedes administrarlo desde tu [panel](https://dashboard.mintlify.com/products/assistant/settings), donde puedes activarlo o desactivarlo, configurar el manejo de respuestas y establecer un límite de gasto.
### Estado del Asistente @@ -44,50 +44,50 @@ Alterna el estado del Asistente para habilitarlo o deshabilitarlo en tu sitio de ### Desvío del Asistente
-Permite que el Asistente redirija las preguntas no resueltas a tu equipo de soporte. Proporciona una dirección de correo electrónico que el Asistente entregará a los usuarios que hagan preguntas a las que no pueda responder. +Permite que el Asistente redirija las preguntas sin respuesta a tu equipo de soporte. Proporciona una dirección de correo electrónico que el Asistente compartirá con los usuarios que hagan preguntas a las que no pueda responder.
### Búsqueda en sitios
- La búsqueda en el sitio está en beta. Para habilitarla en tu sitio de documentación, [contacta a nuestro equipo de ventas](mailto:gtm@mintlify.com). + La búsqueda en sitios está en beta. Para habilitarla en tu sitio de documentación, [contacta a nuestro equipo de ventas](mailto:gtm@mintlify.com). Configura los sitios que el Asistente puede consultar para obtener contexto adicional al responder preguntas. * Los sitios deben ser de acceso público. -* No se admiten sitios que requieran JavaScript para cargar el contenido. +* Los sitios que requieren JavaScript para cargar no son compatibles. Puedes usar la siguiente sintaxis de filtrado al configurar sitios externos: * **Filtrado a nivel de dominio** - * `example.com`: Busca solo en el dominio `example.com` - * `docs.example.com`: Busca solo en el subdominio `docs.example.com` - * `*.example.com`: Busca en todos los subdominios de `example.com` + * `example.com`: Buscar solo en el dominio `example.com` + * `docs.example.com`: Buscar solo en el subdominio `docs.example.com` + * `*.example.com`: Buscar todos los subdominios de `example.com` * **Filtrado a nivel de ruta** - * `docs.example.com/api`: Busca todas las páginas dentro de la subruta `/api` -* **Patrones múltiples** - * Agrega varias entradas para cubrir diferentes secciones de los sitios + * `docs.example.com/api`: Buscar todas las páginas bajo la subruta `/api` +* **Varios patrones** + * Agrega varias entradas para apuntar a diferentes secciones de los sitios
### Límite de gasto
-Establece un límite de gasto para controlar qué ocurre si alcanzas tu cupo de mensajes. De forma predeterminada, el Asistente seguirá respondiendo preguntas de los usuarios después de que alcances tu cupo de mensajes, lo que genera cargos adicionales. +Establece un límite de gasto para controlar qué sucede si alcanzas tu cupo de mensajes. De forma predeterminada, el Asistente seguirá respondiendo preguntas de los usuarios después de que alcances tu cupo, lo que genera cargos por excedente. -En la pestaña **Billing** de la página [Assistant Configurations](https://dashboard.mintlify.com/products/assistant/settings), puedes establecer un límite de gasto para los mensajes del Asistente más allá de tu cupo. Cuando alcanzas tu límite de gasto, el Asistente se deshabilita hasta que se restablezca tu cupo de mensajes. +En la pestaña **Billing** de la página [Assistant Configurations](https://dashboard.mintlify.com/products/assistant/settings), puedes establecer un límite de gasto para los mensajes del Asistente que superen tu cupo. Cuando alcanzas tu límite de gasto, el Asistente se deshabilita hasta que tu cupo de mensajes se restablezca. También puedes configurar alertas de uso para recibir un correo electrónico cuando alcances un porcentaje determinado de tu límite de gasto.
- ## Uso del asistente + ## Uso del Asistente
-Los usuarios pueden acceder al asistente de tres maneras: +Los usuarios pueden acceder al Asistente de tres maneras: * **Atajos de teclado**: ? o Command + I (Ctrl + I en Windows) -* **Botón del asistente** junto a la barra de búsqueda +* **Botón del Asistente** junto a la barra de búsqueda Barra de búsqueda y botón del asistente en modo claro. Barra de búsqueda y botón del asistente en modo oscuro. -* **URLs** con `?assistant=open` al final abrirán el asistente cuando la página cargue. Por ejemplo, [https://mintlify.com/docs?assistant=open](https://mintlify.com/docs?assistant=open). +* **URLs** con `?assistant=open` al final abrirán el Asistente cuando cargue la página. Por ejemplo, [https://mintlify.com/docs?assistant=open](https://mintlify.com/docs?assistant=open). -Todas estas opciones abren un panel de chat en el lado derecho de tu documentación. Los usuarios pueden hacer cualquier pregunta y el Asistente buscará en tu documentación una respuesta. Si no se encuentra información relevante, el Asistente indicará que no puede responder la pregunta. +Todos los métodos abren un panel de chat en el lado derecho de tu documentación. Los usuarios pueden hacer cualquier pregunta y el Asistente buscará en tu documentación una respuesta. Si no se encuentra información relevante, el Asistente responderá que no puede responder la pregunta.
- ## Hacer que el contenido sea apto para la IA + ## Hacer que el contenido sea apto para la ingesta por IA
-Estructura tu documentación para ayudar al asistente a ofrecer respuestas precisas y relevantes. Una organización clara y un contexto completo benefician tanto a las personas lectoras como a la comprensión de la IA. +Estructura tu documentación para ayudar al Asistente a ofrecer respuestas precisas y relevantes. Una organización clara y un contexto completo benefician tanto a las personas lectoras como a la comprensión de la IA. * Usa marcado semántico. * Escribe encabezados descriptivos para las secciones. - * Crea una jerarquía lógica de la información. - * Mantén un formato consistente en toda tu documentación. + * Crea una jerarquía lógica de información. + * Usa un formato coherente en toda tu documentación. * Incluye metadatos completos en el frontmatter de la página. - * Divide los bloques de texto largos en párrafos más cortos. + * Divide los bloques largos de texto en párrafos más cortos. - * Define términos y siglas específicos la primera vez que aparezcan. + * Define términos y siglas específicas la primera vez que aparezcan. * Proporciona suficiente contenido conceptual sobre funcionalidades y procedimientos. * Incluye ejemplos y casos de uso. - * Añade referencias cruzadas a temas relacionados. - * Agrega [páginas ocultas](/es/guides/hidden-pages) con contexto adicional que las personas no necesitan, pero a las que el asistente puede recurrir. + * Crea referencias cruzadas a temas relacionados. + * Agrega [páginas ocultas](/es/guides/hidden-pages) con contexto adicional que las personas usuarias no necesitan, pero a las que el Asistente puede recurrir.
@@ -139,18 +139,18 @@ Estructura tu documentación para ayudar al asistente a ofrecer respuestas preci Revisa y exporta consultas desde tu panel para entender cómo las personas interactúan con tu documentación e identificar oportunidades de mejora. Algunas maneras en que el análisis de consultas puede ayudarte a mejorar tu documentación: -* Identificar brechas de contenido donde las consultas frecuentes reciben respuestas insuficientes. -* Descubrir patrones de comportamiento de los usuarios y necesidades de información comunes a partir de los temas y patrones en las consultas. -* Priorizar páginas con alto tráfico para mejorar su precisión y calidad. +* Identifica brechas de contenido donde las consultas frecuentes reciben respuestas insuficientes. +* Descubre patrones de comportamiento de los usuarios y necesidades de información comunes a partir de los temas y patrones en las consultas. +* Prioriza las páginas con mayor tráfico para mejorar su precisión y calidad. -Puedes explorar las consultas desde tu [panel](https://dashboard.mintlify.com/products/assistant), pero para obtener información más valiosa recomendamos exportar un archivo `CSV` con tus consultas, respuestas y fuentes para analizarlo con tu herramienta de IA preferida. +Puedes explorar consultas desde tu [panel](https://dashboard.mintlify.com/products/assistant), pero para obtener información más sólida te recomendamos exportar un archivo `CSV` con tus consultas, respuestas y fuentes para analizarlo con tu herramienta de IA preferida. 1. Ve a la [página del Asistente](https://dashboard.mintlify.com/products/assistant) en tu panel. 2. Selecciona **Export to CSV**. 3. Analiza los datos exportados con tu herramienta preferida. - + * Resume los temas más comunes de las consultas. - * Enumera las consultas que no tuvieron fuentes citadas. - * Encuentra patrones en las interacciones fallidas. + * Enumera las consultas que no tengan fuentes citadas. + * Encuentra patrones en interacciones fallidas. \ No newline at end of file diff --git a/es/guides/auth0.mdx b/es/guides/auth0.mdx index c3e6c5359..b26b6634c 100644 --- a/es/guides/auth0.mdx +++ b/es/guides/auth0.mdx @@ -1,62 +1,60 @@ --- -title: "Uso de Auth0 con el handshake de OAuth" +title: "Uso de Auth0 con el flujo de OAuth" description: "Si Auth0 es la fuente de verdad para los datos de tus usuarios, puedes configurar Mintlify como una aplicación cliente de OAuth para autenticar a tus usuarios." --- - **Aviso de seguridad**: Aunque proporcionamos esta guía para ayudarte a integrar Auth0 con Mintlify, consulta con tu equipo de seguridad antes de implementar cualquier solución de autenticación. Mintlify no se hace responsable de ningún problema de seguridad que pueda surgir de tu implementación específica. + **Descargo de responsabilidad de seguridad**: Si bien proporcionamos esta guía para ayudarte a integrar Auth0 con Mintlify, consulta con tu equipo de seguridad antes de implementar cualquier solución de autenticación. Mintlify no se hace responsable de los problemas de seguridad que puedan surgir de tu implementación específica. - -
## Descripción general
-Esta guía te guía paso a paso para configurar Auth0 como proveedor de autenticación para tu documentación de Mintlify. Al finalizar, tus usuarios podrán iniciar sesión en tu documentación con sus credenciales de Auth0. +Esta guía te acompaña paso a paso para configurar Auth0 como proveedor de autenticación para tu documentación de Mintlify. Al finalizar, tus usuarios podrán iniciar sesión en tu documentación con sus credenciales de Auth0. - - Inicia sesión en tu panel de Auth0 y navega a **Applications** > **Applications**. Haz clic en el botón **Create Application**, asigna un nombre a tu aplicación (p. ej., “Mintlify”) y selecciona **Regular Web Applications** como tipo de aplicación. Luego, haz clic en **Create**. + + Inicia sesión en tu panel de Auth0 y navega a **Applications** > **Applications**. Haz clic en el botón **Create Application**, asigna un nombre a tu aplicación (por ejemplo, "Mintlify") y selecciona **Regular Web Applications** como tipo de aplicación. Luego haz clic en **Create**. - ![Creating a new application in Auth0](/images/guides/auth0/auth0-create-application.png) + ![Creación de una nueva aplicación en Auth0](/images/guides/auth0/auth0-create-application.png) - - Después de crear tu aplicación, se te dirigirá a la página de configuración de la aplicación. Aquí encontrarás las credenciales esenciales necesarias para la integración con OAuth: + + Después de crear tu aplicación, accederás a la página de configuración de la aplicación. Aquí encontrarás las credenciales esenciales necesarias para la integración con OAuth: - ![Auth0 client settings page](/images/guides/auth0/auth0clientsettings.png) + ![Página de configuración del cliente de Auth0](/images/guides/auth0/auth0clientsettings.png) Toma nota de la siguiente información: - - **Domain**: El dominio de tu tenant de Auth0 (p. ej., `your-tenant.auth0.com`) + - **Domain**: El dominio de tu tenant de Auth0 (por ejemplo, `your-tenant.auth0.com`) - **Client ID**: El identificador público de tu aplicación - **Client Secret**: La clave secreta de tu aplicación (manténla segura) Necesitarás estos valores para configurar Mintlify en el siguiente paso. - - Ve a tu Panel de Mintlify y entra en **Settings** > **Authentication**. Selecciona **OAuth** como método de autenticación y verás el formulario de configuración de OAuth: + + Navega a tu panel de Mintlify y ve a **Settings** > **Authentication**. Selecciona **OAuth** como método de autenticación y verás el formulario de configuración de OAuth: - ![Mintlify OAuth client settings](/images/guides/auth0/mintlifyoauthclientsettings.png) + ![Configuración del cliente OAuth de Mintlify](/images/guides/auth0/mintlifyoauthclientsettings.png) Completa el formulario con los siguientes valores: - - **Authorization URL**: `https://YOUR_AUTH0_DOMAIN/authorize` (reemplaza `YOUR_AUTH0_DOMAIN` por tu dominio real de Auth0 del paso 2) + - **Authorization URL**: `https://YOUR_AUTH0_DOMAIN/authorize` (reemplaza `YOUR_AUTH0_DOMAIN` por tu dominio de Auth0 del paso 2) - **Client ID**: Ingresa el Client ID de tu aplicación de Auth0 - **Client Secret**: Ingresa el Client Secret de tu aplicación de Auth0 - - **Scopes**: Déjalo en blanco a menos que tengas scopes personalizados definidos en Auth0 - - **Token URL**: `https://YOUR_AUTH0_DOMAIN/oauth/token` (reemplaza `YOUR_AUTH0_DOMAIN` por tu dominio real de Auth0) + - **Scopes**: Déjalo en blanco a menos que tengas scopes personalizados en Auth0 + - **Token URL**: `https://YOUR_AUTH0_DOMAIN/oauth/token` (reemplaza `YOUR_AUTH0_DOMAIN` por tu dominio de Auth0) - Después de completar estos datos, haz clic en **Save changes** para guardar tu configuración de OAuth. + Después de completar estos datos, haz clic en **Save changes** para guardar la configuración de OAuth. - + Mintlify generará una URL de redirección única que Auth0 debe reconocer para que el flujo de OAuth funcione correctamente. - Copia la URL de redirección desde la sección de Authentication en tu Panel de Mintlify: - ![Mintlify redirect URL](/images/guides/auth0/mintlifyredirecturl.png) + Copia la URL de redirección desde la configuración de Authentication en tu panel de Mintlify: + ![URL de redirección de Mintlify](/images/guides/auth0/mintlifyredirecturl.png) - Regresa a la página de configuración de tu aplicación en Auth0, desplázate hasta la sección **Application URIs** y pega la URL de redirección en el campo **Allowed Callback URLs**: - ![Auth0 redirect URL configuration](/images/guides/auth0/auth0redirecturl.png) + Vuelve a la página de configuración de tu aplicación en Auth0, desplázate hasta la sección **Application URIs** y pega la URL de redirección en el campo **Allowed Callback URLs**: + ![Configuración de la URL de redirección en Auth0](/images/guides/auth0/auth0redirecturl.png) - Haz clic en **Save Changes** al final de la página de Auth0 para aplicar esta configuración. + Haz clic en **Save Changes** en la parte inferior de la página de Auth0 para aplicar esta configuración. \ No newline at end of file diff --git a/es/guides/changelogs.mdx b/es/guides/changelogs.mdx index f925c8b89..25e5e0354 100644 --- a/es/guides/changelogs.mdx +++ b/es/guides/changelogs.mdx @@ -1,10 +1,10 @@ --- -title: "Registro de cambios" +title: "Registros de cambios" description: "Publica actualizaciones de producto en tu documentación con un canal RSS al que los usuarios pueden suscribirse" icon: "newspaper" --- -Crea un registro de cambios para tu documentación agregando el [Componente de actualización](/es/components/update) a una página. +Crea un registro de cambios para tu documentación añadiendo [componentes de actualización](/es/components/update) a una página. Consulta el [registro de cambios de Mintlify](/es/changelog) como ejemplo: en cada actualización puedes incluir enlaces, imágenes, texto y demostraciones de tus nuevas funciones. @@ -25,90 +25,90 @@ Consulta el [registro de cambios de Mintlify](/es/changelog) como ejemplo: en ca -```mdx Example changelog.mdx +```mdx Ejemplo de changelog.mdx --- title: "Registro de cambios" -description: "Actualizaciones del producto y anuncios" +description: "Actualizaciones y anuncios del producto" --- - Se añadió un nuevo sabor Wintergreen. + Se añadió un nuevo sabor a Wintergreen. - Se publicó una nueva versión del sabor Spearmint, ahora con un 10% más de menta. + Se lanzó una nueva versión del sabor Spearmint, ahora con un 10% más de menta. - Se publicó una nueva versión del sabor Spearmint. + Se lanzó una nueva versión del sabor Spearmint. ```
- ## Personalizar tu registro de cambios + ## Personalizar el registro de cambios
Controla cómo las personas navegan por tu registro de cambios y se mantienen al día con la información de tu producto.
- ### Tabla de contenido + ### Tabla de contenidos
-Cada propiedad `label` de un `Update` crea automáticamente una entrada en la tabla de contenido de la barra lateral derecha. Esta es la navegación predeterminada para tu registro de cambios. +Cada propiedad `label` de un `Update` crea automáticamente una entrada en la tabla de contenidos de la barra lateral derecha. Esta es la navegación predeterminada de tu registro de cambios. - Registro de cambios con tabla de contenido mostrada en modo claro. + Registro de cambios con la tabla de contenidos en modo claro. - Registro de cambios con tabla de contenido mostrada en modo oscuro. + Registro de cambios con la tabla de contenidos en modo oscuro.
### Filtros por etiquetas
-Agrega `tags` a tus componentes `Update` para reemplazar la tabla de contenido con filtros por etiquetas. Los usuarios pueden filtrar el registro de cambios seleccionando una o más etiquetas: +Agrega `tags` a tus componentes `Update` para sustituir la tabla de contenidos por filtros de etiquetas. Los usuarios pueden filtrar el registro de cambios seleccionando una o más etiquetas: -```mdx Tag filters example wrap - - Added a new Wintergreen flavor. +```mdx Ejemplo de ajuste de filtros por etiquetas + + Se añadió un nuevo sabor Wintergreen. - Released a new version of the Spearmint flavor, now with 10% more mint. + Se publicó una nueva versión del sabor Spearmint, ahora con un 10% más de menta. - - Released a new version of the Spearmint flavor. + + Se publicó una nueva versión del sabor Spearmint. - - Deprecated the Peppermint flavor. + + Se retiró el sabor Peppermint. - Released a new version of the Spearmint flavor. + Se publicó una nueva versión del sabor Spearmint. ``` - Registro de cambios en modo claro con el filtro de la etiqueta Peppermint seleccionado. + Registro de cambios en modo claro con el filtro de etiqueta Peppermint seleccionado. - Registro de cambios en modo oscuro con el filtro de la etiqueta Peppermint seleccionado. + Registro de cambios en modo oscuro con el filtro de etiqueta Peppermint seleccionado. - La tabla de contenido y los filtros del registro de cambios se ocultan al usar los modos de página `custom`, `center` o `wide`. Más información sobre [modos de página](/es/pages#page-mode). + La tabla de contenido y los filtros del registro de cambios se ocultan cuando se usan los modos de página `custom`, `center` o `wide`. Más información sobre los [modos de página](/es/pages#page-mode).
### Registros de cambios con suscripción
-Usar componentes `Update` crea un feed RSS al que te puedes suscribir en la URL de tu página con `/rss.xml` añadido. Por ejemplo, `mintlify.com/docs/changelog/rss.xml`. +Usar componentes `Update` crea un feed RSS al que te puedes suscribir en la URL de tu página con `/rss.xml` agregado. Por ejemplo, `mintlify.com/docs/changelog/rss.xml`. -Las entradas se agregan al feed RSS cuando se publican nuevos componentes `Update` y cuando se añaden nuevos encabezados dentro de etiquetas `` existentes. +Las entradas se agregan al feed RSS cuando se publican nuevos componentes `Update` y cuando se agregan nuevos encabezados dentro de etiquetas `` existentes. -Los encabezados de nivel superior de los componentes `Update` se usan como títulos de las entradas del feed RSS, y estas enlazan a sus anclas de encabezado en tu documentación. +Los encabezados de nivel superior de los componentes `Update` se usan como títulos de las entradas del feed RSS y estas enlazan a sus anclas de encabezado en tu documentación. -```xml Example RSS feed +```xml Ejemplo de fuente RSS - <![CDATA[Product updates]]> - + <![CDATA[Actualizaciones de producto]]> + https://mintlify.com/docs RSS for Node Mon, 21 Jul 2025 21:21:47 GMT @@ -116,7 +116,7 @@ Los encabezados de nivel superior de los componentes `Update` se usan como títu https://mintlify.com/docs - <![CDATA[June 2025]]> + <![CDATA[Junio de 2025]]> https://mintlify.com/docs/changelog#june-2025 https://mintlify.com/docs/changelog#june-2025 Mon, 23 Jun 2025 16:54:22 GMT @@ -128,10 +128,10 @@ Los encabezados de nivel superior de los componentes `Update` se usan como títu Los feeds RSS pueden integrarse con Slack, correo electrónico u otras herramientas de suscripción para notificar a los usuarios sobre cambios en el producto. Algunas opciones incluyen: * [Slack](https://slack.com/help/articles/218688467-Add-RSS-feeds-to-Slack) -* [Email](https://zapier.com/apps/email/integrations/rss/1441/send-new-rss-feed-entries-via-email) a través de Zapier +* [Email](https://zapier.com/apps/email/integrations/rss/1441/send-new-rss-feed-entries-via-email) mediante Zapier * Bots de Discord como [Readybot](https://readybot.io) o [RSS Feeds to Discord Bot](https://rss.app/en/bots/rssfeeds-discord-bot) -Para facilitar el descubrimiento del feed RSS, puedes mostrar un botón con el ícono de RSS que enlace al feed en la parte superior de la página. Agrega `rss: true` al frontmatter de la página: +Para que el feed RSS sea fácil de descubrir, puedes mostrar un botón con el ícono de RSS que enlace al feed en la parte superior de la página. Agrega `rss: true` al frontmatter de la página: ```mdx --- @@ -140,7 +140,7 @@ rss: true ``` - Página de registro de cambios en modo claro con el botón del feed RSS habilitado. + Página del registro de cambios en modo claro con el botón del feed RSS habilitado. - Página de registro de cambios en modo oscuro con el botón del feed RSS habilitado. + Página del registro de cambios en modo oscuro con el botón del feed RSS habilitado. diff --git a/es/guides/claude-code.mdx b/es/guides/claude-code.mdx index 16079cae5..3f9982bd2 100644 --- a/es/guides/claude-code.mdx +++ b/es/guides/claude-code.mdx @@ -4,7 +4,7 @@ description: "Configura Claude Code para ayudar a escribir, revisar y actualizar icon: "asterisk" --- -Claude Code es una herramienta de línea de comandos con capacidades de agente que puede ayudarte a mantener tu documentación. Puede redactar contenido nuevo, revisar páginas existentes y mantener la documentación actualizada. +Claude Code es una herramienta de línea de comandos con capacidades de agente que puede ayudarte a mantener tu documentación. Puede redactar contenido nuevo, revisar páginas existentes y mantener la documentación al día. Puedes entrenar a Claude Code para que comprenda tus estándares y flujos de trabajo de documentación añadiendo un archivo `CLAUDE.md` a tu proyecto y afinándolo con el tiempo. @@ -15,136 +15,141 @@ Puedes entrenar a Claude Code para que comprenda tus estándares y flujos de tra
**Requisitos previos:** -- Suscripción activa a Claude (Pro, Max o acceso por API) + +* Suscripción activa a Claude (Pro, Max o acceso mediante API) **Configuración:** + 1. Instala Claude Code: - ```bash - npm install -g @anthropic-ai/claude-code - ``` -2. Ve a tu directorio de documentación. -3. (Opcional) Agrega el archivo `CLAUDE.md` que aparece a continuación a tu proyecto. -4. Ejecuta `claude` para empezar. +```bash +npm install -g @anthropic-ai/claude-code +``` + +2. Ve al directorio de tus docs. +3. (Opcional) Añade el archivo `CLAUDE.md` que aparece a continuación a tu proyecto. +4. Ejecuta `claude` para empezar.
## Plantilla de CLAUDE.md
-Guarda un archivo `CLAUDE.md` en la raíz de tu directorio de documentación para ayudar a Claude Code a comprender tu proyecto. Este archivo entrena a Claude Code en tus estándares de documentación, preferencias y flujos de trabajo. Consulta [Manage Claude's memory](https://docs.anthropic.com/en/docs/claude-code/memory) en la documentación de Anthropic para más información. +Guarda un archivo `CLAUDE.md` en la raíz de tu directorio de documentación para ayudar a Claude Code a comprender tu proyecto. Este archivo entrena a Claude Code en tus estándares de documentación, preferencias y flujos de trabajo. Consulta [Manage Claude's memory](https://docs.anthropic.com/en/docs/claude-code/memory) en la documentación de Anthropic para obtener más información. -Copia este ejemplo de plantilla o ajústalo según las especificaciones de tu documentación: +Copia esta plantilla de ejemplo o ajústala según las especificaciones de tu documentación: ```mdx -# Mintlify documentation +# Documentación de Mintlify -## Working relationship +## Relación de trabajo - Puedes cuestionar ideas; esto puede llevar a una mejor documentación. Cita fuentes y explica tu razonamiento cuando lo hagas -- SIEMPRE pide aclaraciones en lugar de asumir +- SIEMPRE pide aclaraciones en lugar de hacer suposiciones - NUNCA mientas, adivines ni inventes información -## Project context +## Contexto del proyecto - Formato: archivos MDX con frontmatter YAML - Configuración: docs.json para navegación, tema y ajustes - Componentes: componentes de Mintlify -## Content strategy -- Documenta lo justo para que el usuario tenga éxito: ni demasiado, ni demasiado poco -- Prioriza la precisión y la usabilidad de la información -- Procura que el contenido sea perenne cuando sea posible +## Estrategia de contenido +- Documenta lo suficiente para el éxito del usuario: ni demasiado ni demasiado poco +- Prioriza la precisión y la utilidad de la información +- Haz el contenido perenne cuando sea posible - Busca información existente antes de añadir contenido nuevo. Evita la duplicación salvo por un motivo estratégico - Revisa los patrones existentes para mantener la coherencia -- Empieza haciendo los cambios más pequeños razonables +- Empieza realizando los cambios razonables más pequeños ## docs.json - Consulta el [esquema de docs.json](https://mintlify.com/docs.json) al crear el archivo docs.json y la navegación del sitio -## Frontmatter requirements for pages -- title: Título de página claro y descriptivo +## Requisitos de frontmatter para páginas +- title: Título claro y descriptivo de la página - description: Resumen conciso para SEO/navegación -## Writing standards +## Estándares de redacción - Voz en segunda persona ("tú") - Prerrequisitos al inicio del contenido procedimental - Prueba todos los ejemplos de código antes de publicar -- Alinea el estilo y formato con las páginas existentes +- Adapta el estilo y formato al de las páginas existentes - Incluye casos de uso básicos y avanzados -- Etiquetas de lenguaje en todos los bloques de código +- Etiquetas de idioma en todos los bloques de código - Texto alternativo en todas las imágenes -- Rutas relativas para enlaces internos +- Rutas relativas para los enlaces internos -## Git workflow +## Flujo de trabajo con Git - NUNCA uses --no-verify al hacer commits -- Pregunta cómo manejar los cambios sin confirmar antes de empezar -- Crea una nueva rama cuando no exista una clara para los cambios +- Pregunta cómo manejar los cambios no confirmados antes de empezar +- Crea una nueva rama cuando no exista una rama clara para los cambios - Haz commits con frecuencia durante el desarrollo - NUNCA omitas ni desactives los hooks de pre-commit -## Do not +## No hacer - Omitir el frontmatter en cualquier archivo MDX -- Usar URLs absolutas para enlaces internos +- Usar URL absolutas para enlaces internos - Incluir ejemplos de código no probados -- Hacer suposiciones: pide aclaraciones siempre +- Hacer suposiciones: siempre pide aclaraciones ``` -
## Prompts de ejemplo
-Una vez que tengas Claude Code configurado, prueba estos prompts para ver cómo puede ayudar con tareas comunes de documentación. Puedes copiar y pegar estos ejemplos directamente o adaptarlos a tus necesidades específicas. +Una vez que tengas configurado Claude Code, prueba estos prompts para ver cómo puede ayudar con tareas comunes de documentación. Puedes copiar y pegar estos ejemplos directamente o adaptarlos a tus necesidades específicas.
- ### Convertir notas en documentación pulida + ### Convertir notas en documentación de calidad
-Convierte borradores en páginas Markdown bien formateadas con componentes y frontmatter. +Convierte borradores en páginas Markdown bien estructuradas, con componentes y frontmatter. **Prompt de ejemplo:** -```text wrap + +```text ajustar Convierte este texto en una página MDX con el formato correcto: [pega tu texto aquí] ```
- ### Revisar la documentación para mantener la coherencia + ### Revisar la documentación en busca de coherencia
Obtén sugerencias para mejorar el estilo, el formato y el uso de componentes. -**Prompt de ejemplo:** -```text wrap -Revisa los archivos en docs/ y sugiere mejoras para la coherencia y la claridad +**Ejemplo de indicación:** + +```text ajustar +Revisa los archivos en docs/ y sugiere mejoras para mejorar la consistencia y la claridad ```
- ### Actualizar la documentación cuando cambian las características + ### Actualiza la documentación cuando cambien las funcionalidades
-Mantén la documentación actualizada cuando tu producto evolucione. +Mantén la documentación al día a medida que tu producto evoluciona. -**Prompt de ejemplo:** -```text wrap -Nuestra API ahora requiere un parámetro de versión. Actualiza la documentación para incluir version=2024-01 en todos los ejemplos +**Ejemplo de prompt:** + +```text ajustar +Nuestra API ahora requiere un parámetro de versión. Actualiza nuestra documentación para incluir version=2024-01 en todos los ejemplos ```
- ### Generar ejemplos de código completos + ### Genera ejemplos de código completos
Crea ejemplos en varios lenguajes con manejo de errores. -**Prompt de ejemplo:** -```text wrap -Crea ejemplos de código para [tu endpoint de API] en JavaScript, Python y cURL, con manejo de errores -``` +**Ejemplo de prompt:** +```text ajustar +Crea ejemplos de código para [tu endpoint de API] en JavaScript, Python y cURL con gestión de errores +```
- ## Ampliar Claude Code + ## Extender Claude Code
Además de interactuar manualmente con Claude Code, puedes integrarlo en tus flujos de trabajo existentes. @@ -153,22 +158,22 @@ Además de interactuar manualmente con Claude Code, puedes integrarlo en tus flu ### Automatización con GitHub Actions
-Ejecuta Claude Code automáticamente cuando haya cambios en el código para mantener la documentación actualizada. Puedes activar revisiones de documentación en pull requests o actualizar ejemplos cuando se detecten cambios en la API. +Ejecuta Claude Code automáticamente cuando haya cambios en el código para mantener la documentación al día. Puedes activar revisiones de documentación en pull requests o actualizar ejemplos cuando se detecten cambios en la API.
- ### Flujos de trabajo multiinstancia + ### Flujos de trabajo con múltiples instancias
-Usa sesiones separadas de Claude Code para distintas tareas: una para redactar contenido nuevo y otra para revisión y control de calidad. Esto ayuda a mantener la consistencia y a detectar problemas que una sola sesión podría pasar por alto. +Usa sesiones separadas de Claude Code para distintas tareas: una para redactar contenido nuevo y otra para revisión y aseguramiento de la calidad. Esto ayuda a mantener la coherencia y a detectar problemas que una sola sesión podría pasar por alto.
### Colaboración en equipo
-Comparte tu archivo `CLAUDE.md` afinado con tu equipo para garantizar estándares de documentación consistentes entre todos los colaboradores. Los equipos suelen desarrollar prompts y flujos de trabajo específicos del proyecto que pasan a formar parte de su proceso de documentación. +Comparte tu archivo `CLAUDE.md` refinado con tu equipo para garantizar estándares de documentación consistentes entre todos los colaboradores. Los equipos suelen desarrollar prompts y flujos de trabajo específicos del proyecto que pasan a formar parte de su proceso de documentación.
### Comandos personalizados
-Crea comandos de barra reutilizables en `.claude/commands/` para tareas frecuentes de documentación específicas de tu proyecto o equipo. +Crea comandos reutilizables con barra en `.claude/commands/` para tareas de documentación frecuentes específicas de tu proyecto o equipo. diff --git a/es/guides/csp-configuration.mdx b/es/guides/csp-configuration.mdx index 0ce92611f..24e22ce83 100644 --- a/es/guides/csp-configuration.mdx +++ b/es/guides/csp-configuration.mdx @@ -1,68 +1,82 @@ --- title: "Configuración de Content Security Policy (CSP)" sidebarTitle: "Configuración de CSP" -description: "Lista de permitidos de dominios y configuraciones de encabezados para proxies inversos, cortafuegos y redes que aplican políticas de seguridad estrictas" +description: "Lista de dominios permitidos y configuración de encabezados para proxies inversos, firewalls y redes que aplican políticas de seguridad estrictas" --- -Content Security Policy (CSP) es un estándar de seguridad que ayuda a prevenir ataques de cross-site scripting (XSS) al controlar qué recursos puede cargar una página web. Mintlify ofrece una CSP predeterminada que protege a la mayoría de los sitios. Si alojas tu documentación detrás de un proxy inverso o un cortafuegos que sobrescribe la CSP predeterminada, es posible que debas configurar los encabezados de CSP para que las funciones funcionen correctamente. +Content Security Policy (CSP) es un estándar de seguridad que ayuda a prevenir ataques de cross-site scripting (XSS) al controlar qué recursos puede cargar una página web. Mintlify sirve una CSP predeterminada que protege a la mayoría de los sitios. Si alojas tu documentación detrás de un proxy inverso o firewall que sobrescribe la CSP predeterminada, es posible que debas configurar los encabezados CSP para que las funciones operen correctamente.
## Directivas CSP
-Se utilizan las siguientes directivas CSP para controlar qué recursos se pueden cargar: +Las siguientes directivas de CSP se utilizan para controlar qué recursos se pueden cargar: - `script-src`: Controla qué scripts se pueden ejecutar - `style-src`: Controla qué hojas de estilo se pueden cargar - `font-src`: Controla qué fuentes se pueden cargar - `img-src`: Controla qué imágenes, iconos y logotipos se pueden cargar -- `connect-src`: Controla con qué URL se puede establecer conexión para llamadas a la API y conexiones WebSocket -- `frame-src`: Controla qué URL se pueden incrustar en marcos o iframes -- `default-src`: Valor predeterminado para otras directivas cuando no se configura explícitamente +- `connect-src`: Controla con qué URLs se puede establecer conexión para llamadas de API y conexiones WebSocket +- `frame-src`: Controla qué URLs se pueden incrustar en marcos o iframes +- `default-src`: Valor predeterminado para otras directivas cuando no se establece explícitamente
- ## Lista de dominios permitidos + ## Lista de permitidos de dominios
-| Dominio | Propósito | Directiva CSP | Requerido | +| Dominio | Propósito | Directiva CSP | Obligatorio | |:-------|:--------|:--------------|:-------| -| `d4tuoctqmanu0.cloudfront.net` | CSS y fuentes de KaTeX | `style-src`, `font-src` | Requerido | -| `*.mintlify.dev` | Contenido de la documentación | `connect-src` | Requerido | -| `d3gk2c5xim1je2.cloudfront.net` | Iconos, imágenes, logotipos | `img-src` | Requerido | +| `d4tuoctqmanu0.cloudfront.net` | CSS y fuentes de KaTeX | `style-src`, `font-src` | Obligatorio | +| `*.mintlify.dev` | Contenido de documentación | `connect-src`, `frame-src` | Obligatorio | +| `*.mintlify.com` | Panel, API, proxy de analíticas | `connect-src` | Obligatorio | +| `leaves.mintlify.com` | API del Asistente | `connect-src` | Obligatorio | +| `d3gk2c5xim1je2.cloudfront.net` | Iconos, imágenes, logotipos | `img-src` | Obligatorio | +| `d1ctpt7j8wusba.cloudfront.net` | Archivos de versiones y lanzamientos de Mint | `connect-src` | Obligatorio | +| `mintcdn.com` | Imágenes, favicons | `img-src`, `connect-src` | Obligatorio | +| `*.mintcdn.com` | Imágenes, favicons | `img-src`, `connect-src` | Obligatorio | +| `api.mintlifytrieve.com` | API de búsqueda | `connect-src` | Obligatorio | +| `cdn.jsdelivr.net` | Recursos de emoji para imágenes OG | `script-src`, `img-src` | Obligatorio | +| `fonts.googleapis.com` | Google Fonts | `style-src`, `font-src` | Opcional | | `www.googletagmanager.com` | Google Analytics/GTM | `script-src`, `connect-src` | Opcional | | `cdn.segment.com` | Analíticas de Segment | `script-src`, `connect-src` | Opcional | | `plausible.io` | Analíticas de Plausible | `script-src`, `connect-src` | Opcional | +| `us.posthog.com` | Analíticas de PostHog | `connect-src` | Opcional | +| `cdn.getkoala.com` | Analíticas de Koala | `script-src` | Opcional | | `tag.clearbitscripts.com` | Seguimiento de Clearbit | `script-src` | Opcional | | `cdn.heapanalytics.com` | Analíticas de Heap | `script-src` | Opcional | | `chat.cdn-plain.com` | Widget de chat de Plain | `script-src` | Opcional | | `chat-assets.frontapp.com` | Widget de chat de Front | `script-src` | Opcional | +| `browser.sentry-cdn.com` | Seguimiento de errores de Sentry | `script-src`, `connect-src` | Opcional | +| `js.sentry-cdn.com` | SDK de JavaScript de Sentry | `script-src` | Opcional |
## Ejemplo de configuración de CSP
- Incluye únicamente los dominios de los servicios que usas. Elimina cualquier dominio de analítica que no hayas configurado para tu documentación. + Incluye únicamente los dominios de los servicios que uses. Elimina cualquier dominio de analítica que no hayas configurado para tu documentación. -```text ajustar +```text wrap Content-Security-Policy: default-src 'self'; -script-src 'self' 'unsafe-inline' 'unsafe-eval' www.googletagmanager.com cdn.segment.com plausible.io tag.clearbitscripts.com cdn.heapanalytics.com -chat.cdn-plain.com chat-assets.frontapp.com; -style-src 'self' 'unsafe-inline' d4tuoctqmanu0.cloudfront.net; -font-src 'self' d4tuoctqmanu0.cloudfront.net; -img-src 'self' data: blob: d3gk2c5xim1je2.cloudfront.net; -connect-src 'self' *.mintlify.dev www.googletagmanager.com cdn.segment.com plausible.io; +script-src 'self' 'unsafe-inline' 'unsafe-eval' cdn.jsdelivr.net www.googletagmanager.com cdn.segment.com plausible.io +us.posthog.com cdn.getkoala.com tag.clearbitscripts.com cdn.heapanalytics.com chat.cdn-plain.com chat-assets.frontapp.com +browser.sentry-cdn.com js.sentry-cdn.com; +style-src 'self' 'unsafe-inline' d4tuoctqmanu0.cloudfront.net fonts.googleapis.com; +font-src 'self' d4tuoctqmanu0.cloudfront.net fonts.googleapis.com; +img-src 'self' data: blob: d3gk2c5xim1je2.cloudfront.net mintcdn.com *.mintcdn.com cdn.jsdelivr.net; +connect-src 'self' *.mintlify.dev *.mintlify.com d1ctpt7j8wusba.cloudfront.net mintcdn.com *.mintcdn.com +api.mintlifytrieve.com www.googletagmanager.com cdn.segment.com plausible.io us.posthog.com browser.sentry-cdn.com; frame-src 'self' *.mintlify.dev; ```
- ## Configuraciones comunes según el tipo de proxy + ## Configuraciones comunes por tipo de proxy
-La mayoría de los proxies inversos admiten añadir encabezados personalizados. +La mayoría de los proxies inversos permiten añadir encabezados personalizados.
### Configuración de Cloudflare @@ -74,14 +88,14 @@ Crea una regla de transformación de encabezados de respuesta: 2. Selecciona **Create rule > Response Header Transform Rule**. 3. Configura la regla: -- **Modify response header**: Set static +- **Modify response header**: Fijar estático - **Header name**: `Content-Security-Policy` - **Header value**: ```text wrap - default-src 'self'; script-src 'self' 'unsafe-inline' 'unsafe-eval'; style-src 'self' 'unsafe-inline' d4tuoctqmanu0.cloudfront.net; font-src 'self' d4tuoctqmanu0.cloudfront.net; img-src 'self' data: blob: d3gk2c5xim1je2.cloudfront.net; connect-src 'self' *.mintlify.dev; frame-src 'self' *.mintlify.dev; + default-src 'self'; script-src 'self' 'unsafe-inline' 'unsafe-eval' cdn.jsdelivr.net; style-src 'self' 'unsafe-inline' d4tuoctqmanu0.cloudfront.net fonts.googleapis.com; font-src 'self' d4tuoctqmanu0.cloudfront.net fonts.googleapis.com; img-src 'self' data: blob: d3gk2c5xim1je2.cloudfront.net mintcdn.com *.mintcdn.com cdn.jsdelivr.net; connect-src 'self' *.mintlify.dev *.mintlify.com d1ctpt7j8wusba.cloudfront.net mintcdn.com *.mintcdn.com api.mintlifytrieve.com; frame-src 'self' *.mintlify.dev; ``` -4. Publica la regla. +4. Implementa la regla.
### Configuración de AWS CloudFront @@ -96,7 +110,7 @@ Añade una política de encabezados de respuesta en CloudFront: "Config": { "SecurityHeadersConfig": { "ContentSecurityPolicy": { - "ContentSecurityPolicy": "default-src 'self'; script-src 'self' 'unsafe-inline' 'unsafe-eval'; style-src 'self' 'unsafe-inline' d4tuoctqmanu0.cloudfront.net; font-src 'self' d4tuoctqmanu0.cloudfront.net; img-src 'self' data: blob: d3gk2c5xim1je2.cloudfront.net; connect-src 'self' *.mintlify.dev; frame-src 'self' *.mintlify.dev;", + "ContentSecurityPolicy": "default-src 'self'; script-src 'self' 'unsafe-inline' 'unsafe-eval' cdn.jsdelivr.net; style-src 'self' 'unsafe-inline' d4tuoctqmanu0.cloudfront.net fonts.googleapis.com; font-src 'self' d4tuoctqmanu0.cloudfront.net fonts.googleapis.com; img-src 'self' data: blob: d3gk2c5xim1je2.cloudfront.net mintcdn.com *.mintcdn.com cdn.jsdelivr.net; connect-src 'self' *.mintlify.dev *.mintlify.com d1ctpt7j8wusba.cloudfront.net mintcdn.com *.mintcdn.com api.mintlifytrieve.com; frame-src 'self' *.mintlify.dev;", "Override": true } } @@ -110,7 +124,7 @@ Añade una política de encabezados de respuesta en CloudFront: ### Configuración de Vercel
-Añade a tu `vercel.json`: +Agrega lo siguiente a tu `vercel.json`: ```json { @@ -120,7 +134,7 @@ Añade a tu `vercel.json`: "headers": [ { "key": "Content-Security-Policy", - "value": "default-src 'self'; script-src 'self' 'unsafe-inline' 'unsafe-eval'; style-src 'self' 'unsafe-inline' d4tuoctqmanu0.cloudfront.net; font-src 'self' d4tuoctqmanu0.cloudfront.net; img-src 'self' data: blob: d3gk2c5xim1je2.cloudfront.net; connect-src 'self' *.mintlify.dev; frame-src 'self' *.mintlify.dev;" + "value": "default-src 'self'; script-src 'self' 'unsafe-inline' 'unsafe-eval' cdn.jsdelivr.net; style-src 'self' 'unsafe-inline' d4tuoctqmanu0.cloudfront.net fonts.googleapis.com; font-src 'self' d4tuoctqmanu0.cloudfront.net fonts.googleapis.com; img-src 'self' data: blob: d3gk2c5xim1je2.cloudfront.net mintcdn.com *.mintcdn.com cdn.jsdelivr.net; connect-src 'self' *.mintlify.dev *.mintlify.com d1ctpt7j8wusba.cloudfront.net mintcdn.com *.mintcdn.com api.mintlifytrieve.com; frame-src 'self' *.mintlify.dev;" } ] } @@ -133,11 +147,11 @@ Añade a tu `vercel.json`: ## Solución de problemas
-Identifica infracciones de la CSP en la consola de tu navegador: +Identifica infracciones de CSP en la consola de tu navegador: 1. Abre las herramientas de desarrollador de tu navegador. 2. Ve a la pestaña **Console**. -3. Busca errores que empiecen por: +3. Busca errores que comiencen con: - `Content Security Policy: The page's settings blocked the loading of a resource` - `Refused to load the script/stylesheet because it violates the following Content Security Policy directive` - `Refused to connect to because it violates the following Content Security Policy directive` \ No newline at end of file diff --git a/es/guides/cursor.mdx b/es/guides/cursor.mdx index 2a43708a0..f2c5abdbc 100644 --- a/es/guides/cursor.mdx +++ b/es/guides/cursor.mdx @@ -6,107 +6,112 @@ icon: "box" Convierte a Cursor en un experto en documentación que conozca tus componentes, tu guía de estilo y tus mejores prácticas. + +
- ## Uso de Cursor con Mintlify + ## Usar Cursor con Mintlify
-Las reglas de Cursor proporcionan un contexto persistente sobre tu documentación, lo que garantiza sugerencias más coherentes que se ajusten a tus estándares y estilo. +Las reglas de Cursor proporcionan contexto persistente sobre tu documentación, lo que garantiza sugerencias más coherentes y alineadas con tus estándares y estilo. * **Reglas de proyecto**: se almacenan en el repositorio de tu documentación y se comparten con tu equipo. * **Reglas de usuario**: se aplican a tu entorno personal de Cursor. Recomendamos crear reglas de proyecto para tu documentación, de modo que todas las personas colaboradoras tengan acceso a las mismas reglas. -Crea archivos de reglas en el directorio `.cursor/rules` de tu repositorio de documentación. Consulta la [documentación de Cursor Rules](https://docs.cursor.com/context/rules) para ver las instrucciones completas de configuración. +Crea archivos de reglas en el directorio `.cursor/rules` del repositorio de tu documentación. Consulta la [documentación de Cursor Rules](https://docs.cursor.com/context/rules) para ver las instrucciones completas de configuración. + +
## Regla de proyecto de ejemplo
-Esta regla proporciona a Cursor el contexto necesario para formatear correctamente los componentes de Mintlify y seguir las mejores prácticas de redacción técnica. +Esta regla ofrece a Cursor el contexto necesario para formatear correctamente los componentes de Mintlify y seguir las mejores prácticas de redacción técnica. Puedes usar este ejemplo tal cual o personalizarlo para tu documentación: -* **Estándares de redacción**: Actualiza las pautas de lenguaje para alinearlas con tu guía de estilo. +* **Estándares de redacción**: Actualiza las pautas lingüísticas para que se ajusten a tu guía de estilo. * **Patrones de componentes**: Añade componentes específicos del proyecto o modifica los ejemplos existentes. -* **Ejemplos de código**: Sustituye los ejemplos genéricos por llamadas y respuestas reales de tu API. +* **Ejemplos de código**: Sustituye los ejemplos genéricos por llamadas y respuestas reales de la API de tu producto. * **Preferencias de estilo y tono**: Ajusta la terminología, el formato y otras reglas. -Añade esta regla, con las modificaciones que necesites, como un archivo `.mdc` en el directorio `.cursor/rules` de tu repositorio de documentación. +Añade esta regla, con cualquier modificación, como un archivo `.mdc` en el directorio `.cursor/rules` de tu repositorio de documentación. + -```mdx wrap + +````mdx envolver # Regla de redacción técnica de Mintlify -Eres un asistente de escritura con IA especializado en crear documentación técnica excepcional usando componentes de Mintlify y siguiendo las mejores prácticas de redacción técnica del sector. -``` +Eres un asistente de redacción con IA especializado en crear documentación técnica excepcional usando componentes de Mintlify y siguiendo prácticas líderes de redacción técnica en la industria. ## Principios básicos de redacción ### Requisitos de lenguaje y estilo -* Usa un lenguaje claro y directo, adecuado para audiencias técnicas -* Escribe en segunda persona ("tú") para instrucciones y procedimientos -* Prefiere la voz activa frente a la pasiva -* Emplea el tiempo presente para estados actuales y el futuro para resultados -* Evita la jerga salvo que sea necesaria y define los términos la primera vez que se usen -* Mantén una terminología consistente en toda la documentación -* Mantén las oraciones concisas aportando el contexto necesario -* Usa una estructura paralela en listas, encabezados y procedimientos - -### Estándares de organización de contenido - -* Empieza por la información más importante (pirámide invertida) -* Usa divulgación progresiva: conceptos básicos antes que los avanzados -* Divide los procedimientos complejos en pasos numerados -* Incluye requisitos previos y contexto antes de las instrucciones -* Indica los resultados esperados para cada paso principal -* Usa encabezados descriptivos y ricos en palabras clave para la navegación y el SEO -* Agrupa la información relacionada de forma lógica con separaciones claras entre secciones +- Usa un lenguaje claro y directo, apropiado para audiencias técnicas +- Escribe en segunda persona ("tú") para instrucciones y procedimientos +- Prefiere la voz activa sobre la pasiva +- Emplea el presente para estados actuales y el futuro para resultados +- Evita la jerga salvo que sea necesaria y define los términos la primera vez que se usen +- Mantén una terminología consistente en toda la documentación +- Mantén oraciones concisas y proporciona el contexto necesario +- Usa estructuras paralelas en listas, encabezados y procedimientos + +### Estándares de organización del contenido + +- Comienza con la información más importante (estructura de pirámide invertida) +- Aplica divulgación progresiva: conceptos básicos antes que los avanzados +- Divide los procedimientos complejos en pasos numerados +- Incluye prerrequisitos y contexto antes de las instrucciones +- Indica los resultados esperados para cada paso principal +- Usa encabezados descriptivos y ricos en palabras clave para navegación y SEO +- Agrupa la información relacionada de forma lógica con separaciones claras de sección ### Enfoque centrado en el usuario -* Enfócate en los objetivos y resultados del usuario, no en las funciones del sistema -* Anticipa preguntas comunes y abórdalas proactivamente -* Incluye una sección de solución de problemas para los puntos de falla más probables -* Escribe para facilitar el escaneo con encabezados claros, listas y espacios en blanco -* Incluye pasos de verificación para confirmar el éxito +- Enfócate en los objetivos y resultados del usuario en lugar de las funciones del sistema +- Anticipa preguntas comunes y abórdalas proactivamente +- Incluye solución de problemas para puntos de fallo probables +- Optimiza para lectura en diagonal con encabezados claros, listas y espacios en blanco +- Incluye pasos de verificación para confirmar el éxito ## Referencia de componentes de Mintlify ### docs.json -* Consulta el [esquema de docs.json](https://mintlify.com/docs.json) al crear el archivo docs.json y la navegación del sitio +- Consulta el [esquema de docs.json](https://mintlify.com/docs.json) al crear el archivo docs.json y la navegación del sitio -### Componentes de llamado de atención +### Componentes de aviso -#### Note - Información adicional útil +#### Nota - Información adicional útil - Información complementaria que respalda el contenido principal sin interrumpir el flujo +Información complementaria que respalda el contenido principal sin interrumpir el flujo -#### Tip - Mejores prácticas y consejos +#### Consejo - Mejores prácticas y trucos - Consejos de expertos, atajos o mejores prácticas que aumentan la probabilidad de éxito del usuario +Consejos de expertos, atajos o mejores prácticas que aumentan el éxito del usuario -#### Warning - Advertencias importantes +#### Advertencia - Precauciones importantes - Información crítica sobre posibles problemas, cambios incompatibles o acciones destructivas +Información crítica sobre posibles problemas, cambios incompatibles o acciones destructivas #### Info - Información contextual neutral - Información de contexto, antecedentes o anuncios neutrales +Información de fondo, contexto o anuncios neutrales -#### Check - Confirmaciones de éxito +#### Verificación - Confirmaciones de éxito - Confirmaciones positivas, finalizaciones correctas o indicadores de logro +Confirmaciones positivas, finalizaciones exitosas o indicadores de logro ### Componentes de código @@ -130,22 +135,22 @@ const apiConfig = { Ejemplo de un grupo de código: - ```javascript Node.js - const response = await fetch('/api/endpoint', { - headers: { Authorization: `Bearer ${apiKey}` } - }); - ``` +```javascript Node.js +const response = await fetch('/api/endpoint', { + headers: { Authorization: `Bearer ${apiKey}` } +}); +``` - ```python Python - import requests - response = requests.get('/api/endpoint', - headers={'Authorization': f'Bearer {api_key}'}) - ``` +```python Python +import requests +response = requests.get('/api/endpoint', + headers={'Authorization': f'Bearer {api_key}'}) +``` - ```curl cURL - curl -X GET '/api/endpoint' \ - -H 'Authorization: Bearer YOUR_API_KEY' - ``` +```curl cURL +curl -X GET '/api/endpoint' \ + -H 'Authorization: Bearer YOUR_API_KEY' +``` #### Ejemplos de solicitud/respuesta @@ -153,22 +158,22 @@ Ejemplo de un grupo de código: Ejemplo de documentación de solicitud/respuesta: - ```bash cURL - curl -X POST 'https://api.example.com/users' \ - -H 'Content-Type: application/json' \ - -d '{"name": "John Doe", "email": "john@example.com"}' - ``` +```bash cURL +curl -X POST 'https://api.example.com/users' \ + -H 'Content-Type: application/json' \ + -d '{"name": "John Doe", "email": "john@example.com"}' +``` - ```json Success - { - "id": "user_123", - "name": "John Doe", - "email": "john@example.com", - "created_at": "2024-01-15T10:30:00Z" - } - ``` +```json Éxito +{ + "id": "user_123", + "name": "John Doe", + "email": "john@example.com", + "created_at": "2024-01-15T10:30:00Z" +} +``` ### Componentes estructurales @@ -178,25 +183,25 @@ Ejemplo de documentación de solicitud/respuesta: Ejemplo de instrucciones paso a paso: - - Ejecuta `npm install` para instalar los paquetes necesarios. - - - Verifica la instalación ejecutando `npm list`. - - - - - Crea un archivo `.env` con tus credenciales de API. - - ```bash - API_KEY=your_api_key_here - ``` - - - Nunca subas claves de API al control de versiones. - - + + Ejecuta `npm install` para instalar los paquetes requeridos. + + + Verifica la instalación ejecutando `npm list`. + + + + + Crea un archivo `.env` con tus credenciales de API. + + ```bash + API_KEY=your_api_key_here + ``` + + + Nunca subas claves de API al control de versiones. + + #### Pestañas para contenido alternativo @@ -204,26 +209,26 @@ Ejemplo de instrucciones paso a paso: Ejemplo de contenido con pestañas: - - ```bash - brew install node - npm install -g package-name - ``` - - - - ```powershell - choco install nodejs - npm install -g package-name - ``` - - - - ```bash - sudo apt install nodejs npm - npm install -g package-name - ``` - + + ```bash + brew install node + npm install -g package-name + ``` + + + + ```powershell + choco install nodejs + npm install -g package-name + ``` + + + + ```bash + sudo apt install nodejs npm + npm install -g package-name + ``` + #### Acordeones para contenido plegable @@ -231,38 +236,38 @@ Ejemplo de contenido con pestañas: Ejemplo de grupos de acordeón: - - * **Bloqueo por firewall**: Asegúrate de que los puertos 80 y 443 estén abiertos - * **Configuración de proxy**: Define la variable de entorno HTTP_PROXY - * **Resolución DNS**: Prueba usar 8.8.8.8 como servidor DNS - - - - ```javascript - const config = { - performance: { cache: true, timeout: 30000 }, - security: { encryption: 'AES-256' } - }; - ``` - + + - **Bloqueo por firewall**: Asegúrate de que los puertos 80 y 443 estén abiertos + - **Configuración de proxy**: Define la variable de entorno HTTP_PROXY + - **Resolución DNS**: Prueba usar 8.8.8.8 como servidor DNS + + + + ```javascript + const config = { + performance: { cache: true, timeout: 30000 }, + security: { encryption: 'AES-256' } + }; + ``` + -### Tarjetas y columnas para destacar información +### Tarjetas y columnas para enfatizar información Ejemplo de tarjetas y grupos de tarjetas: - - Guía completa desde la instalación hasta tu primera llamada a la API en menos de 10 minutos. + +Recorrido completo desde la instalación hasta tu primera llamada a la API en menos de 10 minutos. - - Aprende a autenticar solicitudes usando claves de API o tokens JWT. - + + Aprende a autenticar solicitudes usando claves de API o tokens JWT. + - - Entiende los límites de tasa y las mejores prácticas para volúmenes altos. - + + Comprende los límites y las mejores prácticas para un uso de alto volumen. + ### Componentes de documentación de API @@ -272,35 +277,35 @@ Ejemplo de tarjetas y grupos de tarjetas: Ejemplo de documentación de parámetros: - Identificador único del usuario. Debe ser un UUID v4 válido. +Identificador único del usuario. Debe tener formato UUID v4 válido. - Dirección de correo electrónico del usuario. Debe ser válida y única en el sistema. +Dirección de correo electrónico del usuario. Debe ser válida y única dentro del sistema. - Número máximo de resultados a devolver. Rango: 1-100. +Número máximo de resultados a retornar. Rango: 1-100. - Token de tipo Bearer para la autenticación de la API. Formato: `Bearer YOUR_API_KEY` +Token Bearer para autenticación de la API. Formato: `Bearer YOUR_API_KEY` -#### Campos de la respuesta +#### Campos de respuesta Ejemplo de documentación de campos de respuesta: - Identificador único asignado al usuario recién creado. +Identificador único asignado al usuario recién creado. - Marca de tiempo en formato ISO 8601 del momento en que se creó el usuario. +Marca de tiempo en formato ISO 8601 del momento en que se creó el usuario. - Lista de permisos asignados a este usuario. +Lista de cadenas de permisos asignadas a este usuario. #### Campos anidados expandibles @@ -308,126 +313,133 @@ Ejemplo de documentación de campos de respuesta: Ejemplo de documentación de campos anidados: - Objeto de usuario completo con todos los datos asociados. - - - - Información del perfil del usuario, incluidos los datos personales. - - - - Nombre del usuario tal como se introdujo durante el registro. - - - - URL de la foto de perfil del usuario. Devuelve null si no se ha configurado un avatar. - - +Objeto de usuario completo con todos los datos asociados. + + + + Información del perfil del usuario, incluidos los datos personales. + + + + Nombre del usuario tal como se ingresó durante el registro. + + + + URL de la foto de perfil del usuario. Devuelve null si no se configuró un avatar. + + -### Medios y componentes avanzados +### Componentes avanzados y de medios #### Marcos para imágenes Envuelve todas las imágenes en marcos: - Panel principal que muestra la vista general de analíticas +Panel principal que muestra una vista general de analíticas - - Panel de analíticas con gráficos + +Panel de analíticas con gráficos #### Videos Usa el elemento de video HTML para contenido de video autoalojado: -