Skip to content

chore: increase build resources faq#147

Merged
mjroson merged 2 commits intodevelopfrom
chore/SLEAK-5093_increase-build-resources-FAQ
Feb 11, 2026
Merged

chore: increase build resources faq#147
mjroson merged 2 commits intodevelopfrom
chore/SLEAK-5093_increase-build-resources-FAQ

Conversation

@lucaiz
Copy link
Contributor

@lucaiz lucaiz commented Feb 10, 2026

Summary by CodeRabbit

  • Documentación
    • Se han añadido nuevas secciones de FAQs en la documentación de Build que cubren problemas comunes de fallos de compilación y proporcionan soluciones para ajustar recursos.
    • Se ha mejorado la documentación de Build Resources con guías detalladas sobre cómo aumentar recursos, cómo elegir valores adecuados y qué sucede cuando se exceden los límites.
    • Se incluyen notas informativas y recomendaciones prácticas para diagnosticar y resolver problemas de recursos en compilaciones e implementaciones.
    • Actualizaciones disponibles en documentación en inglés y español.

@coderabbitai
Copy link

coderabbitai bot commented Feb 10, 2026

Walkthrough

Se añaden secciones de preguntas frecuentes (FAQs) a la documentación de construcción en múltiples idiomas, mejorando la orientación sobre fallos de compilación y gestión de recursos. Se corrige un cierre de directiva incorrecto en la documentación de recursos.

Changes

Cohort / File(s) Summary
Build Documentation - FAQs
content/docs/en/project/build/build.mdx, docs/project/build/build.mdx
Se añade nueva sección de FAQs con información sobre fallos de compilación, síntomas comunes (OOMKilled) y soluciones dirigidas a ajustar recursos de construcción.
Build Resources Documentation - Correcciones y FAQs
content/docs/en/project/build_resources.mdx, docs/project/build_resources.mdx
Se corrige cierre de directiva (-::: a :::). Se añaden tres bloques de detalles expandibles con preguntas frecuentes sobre límites de recursos, incremento de recursos y selección de valores.
Spanish Build Documentation - FAQs
content/docs/es/project/build/build.mdx
Se añade sección de FAQs traducida al español con orientación sobre diagnóstico y remediación de fallos de compilación.
Spanish Build Resources Documentation - Correcciones y FAQs
content/docs/es/project/build_resources.mdx
Se ajusta bloque de advertencia y se añaden tres bloques de acordeón con FAQs traducidas sobre gestión de recursos, incluyendo recomendaciones de incremento y valores.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~10 minutes

Possibly related PRs

  • sleakops/docs#122: Modifica la misma página de documentación (docs/project/build_resources.mdx), añadiendo contenido sobre Deploy Build Resources que se complementa directamente con esta actualización de FAQs.

Suggested reviewers

  • karim090
  • agustinoli

Poem

🍍 Los conflictos de compilación ya no son una piña,
Con FAQs bien estructuradas, la documentación brilla,
En español e inglés, la solución se propicia,
Límites de recursos explicados, ¡qué delicia! 🎉

🚥 Pre-merge checks | ✅ 3
✅ Passed checks (3 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed El título describe con precisión el cambio principal: añade una sección de FAQ sobre recursos de construcción en la documentación.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Post copyable unit tests in a comment
  • Commit unit tests in branch chore/SLEAK-5093_increase-build-resources-FAQ

Tip

Issue Planner is now in beta. Read the docs and try it out! Share your feedback on Discord.


Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands and usage tips.

Copy link

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 1

🤖 Fix all issues with AI agents
In `@content/docs/es/project/build/build.mdx`:
- Around line 49-50: El enlace en build.mdx apunta a la ruta absoluta
"/docs/project/build_resources" que rompe la navegación i18n; actualiza el
enlace en content/docs/es/project/build/build.mdx para que apunte a la versión
en español reemplazando "/docs/project/build_resources" por una ruta relativa
(por ejemplo "../build_resources" o "./build_resources") o por la ruta con
prefijo de locale "/es/docs/project/build_resources" para que resuelva
correctamente al archivo content/docs/es/project/build_resources.mdx.
🧹 Nitpick comments (2)
content/docs/en/project/build_resources.mdx (1)

55-62: El <summary> debería estar en una única línea para evitar que Docusaurus/MDX inserte wrappers <p> extras.

Docusaurus sí soporta Markdown dentro de <details>, así que los patrones que usás acá funcionan. La cosa es que el <summary> está en una línea aparte del contenido, lo que puede ocasionar que MDX envuelva el heading en un <p> innecesario y rompa el comportamiento esperado de <summary>. Lo mismo se ve en varias otras páginas de la documentación.

Para arreglar la piña, metelo todo en una línea o usá HTML directo en el <summary>:

 <details>
-<summary>
-### What happens if my build or deployment exceeds the configured resources?
-</summary>
+<summary><strong>What happens if my build or deployment exceeds the configured resources?</strong></summary>

O si preferís mantener el heading de Markdown:

 <details>
-<summary>
-### What happens if my build or deployment exceeds the configured resources?
-</summary>
+<summary>### What happens if my build or deployment exceeds the configured resources?</summary>

Para las admoniciones ::: dentro de <details>, andan bien como está. Si querés mayor confiabilidad, considerá usar el componente JSX <Admonition> en lugar de la sintaxis de directivas.

docs/project/build/build.mdx (1)

30-51: La sección de FAQs está bien armada, ¡le damos el visto bueno! 👊

El contenido es claro, los síntomas están bien descritos y la solución apunta correctamente a la documentación de recursos. Buena estructura con el bloque <details>/<summary>.

Un solo detalle menor a tener en cuenta:

El ### (h3) dentro del tag <summary> puede no renderizar correctamente en todos los parsers MDX. Dependiendo de la versión de MDX/Docusaurus, mezclar encabezados Markdown dentro de tags HTML inline puede dar resultados inconsistentes. Si notás que no se renderiza bien, considerá usar <strong> en su lugar:

Alternativa sugerida
 <summary>
-### Why is my build failing or getting killed?
+<strong>Why is my build failing or getting killed?</strong>
 </summary>

Comment on lines +49 to +50
**Solución:**
Aumenta los recursos de build en **Proyecto** → **Configuración** → **Deploy Build Resources**. Consulta la documentación de [Recursos de Deploy Build](/docs/project/build_resources) para instrucciones detalladas sobre cómo ajustar las asignaciones de CPU y memoria.
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

⚠️ Potential issue | 🟠 Major

🧩 Analysis chain

🏁 Script executed:

# Check how links are structured in Spanish docs
echo "=== Links in Spanish docs ==="
rg -n '\(/docs/' content/docs/es/ --glob '*.mdx' | head -30

echo ""
echo "=== Check docusaurus config ==="
fd -t f 'docusaurus.config' -o 'docusaurus.config.js' | head -5

Repository: sleakops/docs

Length of output: 6322


🏁 Script executed:

# Look for i18n configuration
echo "=== Search for i18n config files ==="
fd -t f -e json -e js | grep -i 'i18n\|config' | head -20

echo ""
echo "=== Check main config directory ==="
ls -la | grep -E '(docusaurus|config|src)'

Repository: sleakops/docs

Length of output: 506


🏁 Script executed:

cat docusaurus.config.js

Repository: sleakops/docs

Length of output: 4848


🏁 Script executed:

cat -n content/docs/es/project/build/build.mdx | sed -n '45,55p'

Repository: sleakops/docs

Length of output: 604


🏁 Script executed:

# Check if the target file exists
find content/docs -name "*build_resource*" -o -name "*build-resource*"

echo ""
echo "=== Check how other Spanish docs link to English content ==="
# Look for patterns of linking from Spanish to other Spanish docs
rg 'build_resources|build-resources' content/docs/es/

Repository: sleakops/docs

Length of output: 513


🏁 Script executed:

# Check if Spanish docs typically use absolute /docs/ links or relative links
echo "=== Sample of links in Spanish docs (first 10) ==="
rg '\[.*\]\(/docs/' content/docs/es/ --glob '*.mdx' | head -10

echo ""
echo "=== Check if there are any es-prefixed links in Spanish docs ==="
rg '\[.*\]\(/es/docs/' content/docs/es/ --glob '*.mdx' | head -5

echo ""
echo "=== Check links without leading slash (relative) ==="
rg '\[.*\]\((?!/)[^)]+\)' content/docs/es/project/build/build.mdx

Repository: sleakops/docs

Length of output: 2901


🏁 Script executed:

# Check the learned pattern: look at a related file from the learning to see if similar structure exists
cat -n content/docs/es/project/dependency/index.mdx | sed -n '75,85p'

Repository: sleakops/docs

Length of output: 354


Arreglar el enlace para que resuelva correctamente en la versión en español de la documentación.

En Docusaurus con i18n configurado, el enlace /docs/project/build_resources es una ruta absoluta que dirigirá a la versión en inglés. Dado que el archivo destino existe en español (content/docs/es/project/build_resources.mdx), el enlace debería usar una ruta relativa o incluir el prefijo de locale /es/docs/project/build_resources para mantener al usuario en la documentación en español.

🤖 Prompt for AI Agents
In `@content/docs/es/project/build/build.mdx` around lines 49 - 50, El enlace en
build.mdx apunta a la ruta absoluta "/docs/project/build_resources" que rompe la
navegación i18n; actualiza el enlace en content/docs/es/project/build/build.mdx
para que apunte a la versión en español reemplazando
"/docs/project/build_resources" por una ruta relativa (por ejemplo
"../build_resources" o "./build_resources") o por la ruta con prefijo de locale
"/es/docs/project/build_resources" para que resuelva correctamente al archivo
content/docs/es/project/build_resources.mdx.

@mjroson mjroson merged commit da8ac7a into develop Feb 11, 2026
1 check passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants