feat: added dynamic last changelog component#161
Merged
fuzilogik2019 merged 4 commits intodevelopfrom Mar 20, 2026
Merged
Conversation
WalkthroughSe añade el plugin Docusaurus Changes
Sequence DiagramsequenceDiagram
participant FS as Sistema de Archivos
participant Plugin as Plugin: changelog-recent
participant Docusaurus as Datos Globales Docusaurus
participant Component as Componente: RecentChangelog
participant Browser as Navegador
FS->>Plugin: Lee archivos `.md`/`.mdx`
Plugin->>Plugin: Extrae frontmatter con `gray-matter` y parsea secciones
Plugin->>Plugin: Calcula fecha y slug, ordena por fecha y selecciona N
Plugin->>Docusaurus: Publica `recentChangelogs[]`
Component->>Docusaurus: `usePluginData("changelog-recent")`
Docusaurus->>Component: Retorna `recentChangelogs[]`
Component->>Component: Renderiza secciones, badges y enlaces
Component->>Browser: Devuelve HTML para la homepage
Estimated code review effort🎯 4 (Complex) | ⏱️ ~45 minutes Possibly related PRs
Suggested reviewers
Poem
🚥 Pre-merge checks | ✅ 2 | ❌ 1❌ Failed checks (1 warning)
✅ Passed checks (2 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches📝 Generate docstrings
🧪 Generate unit tests (beta)
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. Comment |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 5
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.
Inline comments:
In `@docs/project/vargroup/index.mdx`:
- Around line 150-168: La sección "3. Select a Type and configure your
variables" deja el botón/acción de "Submit" antes de un campo obligatorio
("Mount Path" cuando se elige FILE); mueve el control de envío ("Submit...")
para que aparezca después de la configuración del Type y después de que el
usuario pueda rellenar el Mount Path (es decir, reubica el flujo para que FILE
-> Mount Path -> Submit), y aplica la misma reordenación en la versión en
español del documento (la copia i18n/es correspondiente) para mantener ambos
documentos sincronizados.
- Around line 158-185: Add the missing image files referenced by the Zoom
components: create and commit img/vargroup/vargroup-env.png and
img/vargroup/vargroup-file.png (matching the exact filenames and case) so the
references in docs/project/vargroup/index.mdx and its Spanish translation in
i18n/es/docusaurus-plugin-content-docs/current/project/vargroup/index.mdx
resolve; if you cannot supply final artwork, add appropriately-sized placeholder
PNGs and ensure the Zoom src attributes still point to these filenames and that
both docs build without broken links.
In `@i18n/es/docusaurus-plugin-content-docs/current/cli.mdx`:
- Around line 201-203: The current help text shows a literal placeholder
"sleakops sub-command --help" which appears copy-pastable; update the text to
either use a clear placeholder or concrete examples by replacing "sleakops
sub-command --help" with "sleakops <sub-command> --help" or with real commands
like "sleakops build --help" and "sleakops deploy --help", and ensure
consistency with how the environment flag (-e / --environment and the term
"environment") is documented elsewhere on the page; locate and edit the string
"sleakops sub-command --help" in the CLI docs block to implement this change.
In `@src/components/Homepage/RecentChangelog.jsx`:
- Around line 7-16: The formatDate function currently hardcodes English month
names and the "MMM D, YYYY" layout; replace that with Intl.DateTimeFormat using
the active Docusaurus locale (useDocusaurusContext().locale in the component) so
dates respect localization. Update formatDate to accept a locale (or call
Intl.DateTimeFormat from the component) and format with options { month:
"short", day: "numeric", year: "numeric" } instead of the months array and
manual string assembly; remove the months constant and any fixed "T00:00:00"
hack and let Date/Intl handle formatting.
- Around line 19-31: Las etiquetas hardcodeadas en badgeConfig
(added/fixed/improved) y el texto "+N more" deben internacionalizarse; en
TypeBadge usa las cadenas traducidas en lugar de labels estáticos (por ejemplo
obteniendo la traducción vía el componente/función Translate o
usePlural/translate) y reemplaza el render que genera "+N more" por una llamada
a Translate que acepte el número dinámico (p. ej. una clave like
"changelog.more" con parámetro count) para que tanto badgeConfig (referenciado
por badgeConfig y TypeBadge) como la sección que construye "+N more" usen las
traducciones apropiadas en lugar de texto en inglés.
ℹ️ Review info
⚙️ Run configuration
Configuration used: Organization UI
Review profile: CHILL
Plan: Pro
Run ID: 7d4e7370-755d-4e49-9616-a81ab1b521b4
⛔ Files ignored due to path filters (2)
package-lock.jsonis excluded by!**/package-lock.jsonyarn.lockis excluded by!**/yarn.lock,!**/*.lock
📒 Files selected for processing (14)
content/changelog/es/2026-02-23-version-2.6.0.mdcontent/docs/en/cluster/index.mdxcontent/docs/en/project/workload/job.mdxcontent/docs/es/cluster/index.mdxcontent/docs/es/project/dependency/faqs.mdxcontent/docs/es/project/workload/job.mdxdocs/project/vargroup/index.mdxdocusaurus.config.jsi18n/es/docusaurus-plugin-content-docs/current/cli.mdxi18n/es/docusaurus-plugin-content-docs/current/project/vargroup/index.mdxpackage.jsonplugins/changelog-recent.jssrc/components/Homepage/RecentChangelog.jsxsrc/components/Homepage/RecentChangelog.module.css
💤 Files with no reviewable changes (6)
- content/docs/es/project/dependency/faqs.mdx
- content/docs/en/cluster/index.mdx
- content/changelog/es/2026-02-23-version-2.6.0.md
- content/docs/es/cluster/index.mdx
- content/docs/en/project/workload/job.mdx
- content/docs/es/project/workload/job.mdx
There was a problem hiding this comment.
🧹 Nitpick comments (1)
src/components/Homepage/RecentChangelog.jsx (1)
28-30: Consideración menor sobre el manejo del título.La regex
replace(/^Version\s*/i, "")asume que el título comienza con "Version". Si en el futuro algún changelog tiene un título diferente (o en español como "Versión"), elven la línea 40 podría quedar raro (ej:vMi Título).No es bloqueante, pero podríais considerar manejar ambos idiomas en el regex o validar el formato esperado.
♻️ Sugerencia opcional para soportar títulos en español
function ChangelogEntry({ entry, idx, locale }) { - const version = entry.title.replace(/^Version\s*/i, ""); + const version = entry.title.replace(/^Versi[oó]n\s*/i, "");🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@src/components/Homepage/RecentChangelog.jsx` around lines 28 - 30, The code in ChangelogEntry currently strips only English "Version" via version = entry.title.replace(/^Version\s*/i, which can produce odd results for titles like "Versión" or non-prefixed titles; update the logic in function ChangelogEntry to robustly extract a version token by matching both English and Spanish prefixes (e.g., /^Versi(ón|on)\b[:\s-]*/i) or by validating a semantic version/number pattern and otherwise falling back to using the original entry.title unchanged, ensuring any later code that prefixes with "v" (the usage of variable version) gets a sensible value.
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.
Nitpick comments:
In `@src/components/Homepage/RecentChangelog.jsx`:
- Around line 28-30: The code in ChangelogEntry currently strips only English
"Version" via version = entry.title.replace(/^Version\s*/i, which can produce
odd results for titles like "Versión" or non-prefixed titles; update the logic
in function ChangelogEntry to robustly extract a version token by matching both
English and Spanish prefixes (e.g., /^Versi(ón|on)\b[:\s-]*/i) or by validating
a semantic version/number pattern and otherwise falling back to using the
original entry.title unchanged, ensuring any later code that prefixes with "v"
(the usage of variable version) gets a sensible value.
ℹ️ Review info
⚙️ Run configuration
Configuration used: Organization UI
Review profile: CHILL
Plan: Pro
Run ID: 47d4e3d4-7443-40de-b8a5-777a635b194e
📒 Files selected for processing (1)
src/components/Homepage/RecentChangelog.jsx
There was a problem hiding this comment.
Actionable comments posted: 2
🧹 Nitpick comments (4)
plugins/changelog-recent.js (3)
22-28: Uso de operaciones síncronas de FS dentro de función async.
readdirSyncyreadFileSyncson síncronos y bloquean el event loop. Para un plugin de build no es crítico, pero si el directorio de changelogs crece o hay muchos archivos, podría ralentizar el build. No hace falta arreglarlo a las piñas ahora, pero considerarfs.promisesen el futuro.♻️ Refactor opcional con fs.promises
-const fs = require("fs"); +const fs = require("fs").promises; +const fsSync = require("fs"); const path = require("path"); const matter = require("gray-matter"); // ... async loadContent() { const changelogDir = path.join(context.siteDir, "changelog"); - if (!fs.existsSync(changelogDir)) { + try { + await fs.access(changelogDir); + } catch { return []; } - const files = fs - .readdirSync(changelogDir) - .filter((f) => f.endsWith(".md") || f.endsWith(".mdx")); + const allFiles = await fs.readdir(changelogDir); + const files = allFiles.filter((f) => f.endsWith(".md") || f.endsWith(".mdx")); - const entries = files.map((file) => { - const raw = fs.readFileSync(path.join(changelogDir, file), "utf-8"); + const entries = await Promise.all(files.map(async (file) => { + const raw = await fs.readFile(path.join(changelogDir, file), "utf-8"); // ... - }); + }));🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@plugins/changelog-recent.js` around lines 22 - 28, Replace blocking fs.readdirSync and fs.readFileSync with the async fs.promises API: use await fs.promises.readdir(changelogDir) instead of readdirSync and await fs.promises.readFile(path.join(changelogDir, file), "utf-8") instead of readFileSync; update the surrounding async function so the files mapping that builds entries uses Promise.all to await parsing each file (where you call matter(raw)) and preserve the same frontmatter/content extraction, referencing the existing variables files, changelogDir, entries, and the matter(...) call.
108-116: Regex de heading puede fallar con headings más complejos.El regex
^#{2,3}\s+\**(.+?)\**[:]*\s*$captura headings con asteriscos opcionales, pero si alguien escribe## **New Features** - v1.0o similar, el match va a incluir- v1.0en el heading. No es grave, pero el*?(non-greedy) podría causar comportamientos inesperados.🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@plugins/changelog-recent.js` around lines 108 - 116, The heading regex can capture trailing text like " - v1.0" causing unexpected headings; update the match logic used where headingMatch is created so the captured group (used by cleanHeading and categorizeSection) stops before common separators/version suffixes (e.g., "-", "—", ":" or "vX.Y") — either by narrowing the capture to exclude those chars (use a character class like [^:\-—]+) or by post-processing the raw capture to strip trailing separators/version tokens before passing to cleanHeading and categorizeSection; keep references to headingMatch, cleanHeading, and categorizeSection when applying the change.
163-174: El umbral de 60 caracteres para detectar títulos con ":" es arbitrario.
colonIdx < 60funciona, pero si alguien escribe un título largo (que pase de 60 chars antes del:) se va a tratar todo como título sin descripción. Podría ser confuso en casos edge.🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@plugins/changelog-recent.js` around lines 163 - 174, The 60-character cap on colon detection is arbitrary and can misclassify long titles; update the logic around plainItemMatch/colonIdx so it doesn't rely on colonIdx < 60: either remove the length check and treat any colon (colonIdx > 0) as title/description, or replace the magic number with a named constant (e.g., MAX_TITLE_LEN) and document/centralize it so it's configurable; ensure you still use plainItemMatch[1].trim(), currentSection.items.push with title = text.substring(0, colonIdx).trim() and description = text.substring(colonIdx + 1).trim() when a colon is present, otherwise push title = text and description = "".src/components/Homepage/RecentChangelog.jsx (1)
13-14: Todos los títulos de changelog tienen el prefijo "Version" — la assumption es segura.Se verificó que los 10 changelogs existentes (2025-12-01-V2.3.1, 2025-10-15-V2.0.1, etc.) siguen consistentemente el patrón
"Version X.X.X". Elreplaceen línea 13-14 funciona correctamente con el formato actual.Si en el futuro llegan títulos sin "Version", la salida sería
vMi Título Customen línea 33. Considerar agregar validación si se espera que otros formatos de titulo lleguen al componente, aunque actualmente no es necesario.🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@src/components/Homepage/RecentChangelog.jsx` around lines 13 - 14, La función ChangelogEntry asume que entry.title siempre empieza con el prefijo "Version" al calcular la variable version; agrega una validación para solo quitar el prefijo cuando exista (por ejemplo usando un test regex o startsWith con toLowerCase) y en caso contrario dejar entry.title tal cual; actualiza la asignación de version (la variable usada más abajo) para usar ese valor seguro y evita producir salidas con un prefijo inesperado si llegan títulos en otros formatos.
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.
Inline comments:
In `@plugins/changelog-recent.js`:
- Around line 35-42: El bloque que convierte frontmatter.date a ISO puede lanzar
si el valor es inválido; en la rama donde usas frontmatter.date crea un Date
object (e.g., const parsed = new Date(frontmatter.date)), verifica su validez
con isNaN(parsed.getTime()) (o Date.parse) antes de llamar a
parsed.toISOString(), y si es inválido o lanza, cae al fallback existente que
usa file.match(/^(\d{4}-\d{2}-\d{2})/) o deja date undefined; envuelve la
conversión en un try/catch para evitar excepciones y actualiza la asignación de
date solo cuando la fecha es válida (referencias: frontmatter.date, new
Date(...).toISOString(), parsed.getTime(), file.match).
In `@src/components/Homepage/RecentChangelog.jsx`:
- Around line 86-92: RecentChangelog currently destructures directly from
usePluginData("changelog-recent") (and from useDocusaurusContext().i18n) which
will throw if those return undefined; fix by first assigning pluginData =
usePluginData("changelog-recent") || {} and context = useDocusaurusContext() ||
{} then safely extract recentChangelogs and i18n.currentLocale (e.g., const {
recentChangelogs } = pluginData; const { i18n = {} } = context; const {
currentLocale } = i18n) so the component returns null safely when data is
missing without runtime errors.
---
Nitpick comments:
In `@plugins/changelog-recent.js`:
- Around line 22-28: Replace blocking fs.readdirSync and fs.readFileSync with
the async fs.promises API: use await fs.promises.readdir(changelogDir) instead
of readdirSync and await fs.promises.readFile(path.join(changelogDir, file),
"utf-8") instead of readFileSync; update the surrounding async function so the
files mapping that builds entries uses Promise.all to await parsing each file
(where you call matter(raw)) and preserve the same frontmatter/content
extraction, referencing the existing variables files, changelogDir, entries, and
the matter(...) call.
- Around line 108-116: The heading regex can capture trailing text like " -
v1.0" causing unexpected headings; update the match logic used where
headingMatch is created so the captured group (used by cleanHeading and
categorizeSection) stops before common separators/version suffixes (e.g., "-",
"—", ":" or "vX.Y") — either by narrowing the capture to exclude those chars
(use a character class like [^:\-—]+) or by post-processing the raw capture to
strip trailing separators/version tokens before passing to cleanHeading and
categorizeSection; keep references to headingMatch, cleanHeading, and
categorizeSection when applying the change.
- Around line 163-174: The 60-character cap on colon detection is arbitrary and
can misclassify long titles; update the logic around plainItemMatch/colonIdx so
it doesn't rely on colonIdx < 60: either remove the length check and treat any
colon (colonIdx > 0) as title/description, or replace the magic number with a
named constant (e.g., MAX_TITLE_LEN) and document/centralize it so it's
configurable; ensure you still use plainItemMatch[1].trim(),
currentSection.items.push with title = text.substring(0, colonIdx).trim() and
description = text.substring(colonIdx + 1).trim() when a colon is present,
otherwise push title = text and description = "".
In `@src/components/Homepage/RecentChangelog.jsx`:
- Around line 13-14: La función ChangelogEntry asume que entry.title siempre
empieza con el prefijo "Version" al calcular la variable version; agrega una
validación para solo quitar el prefijo cuando exista (por ejemplo usando un test
regex o startsWith con toLowerCase) y en caso contrario dejar entry.title tal
cual; actualiza la asignación de version (la variable usada más abajo) para usar
ese valor seguro y evita producir salidas con un prefijo inesperado si llegan
títulos en otros formatos.
ℹ️ Review info
⚙️ Run configuration
Configuration used: Organization UI
Review profile: CHILL
Plan: Pro
Run ID: 8cf12cd6-66ca-43b8-a087-1568ede1ab35
📒 Files selected for processing (3)
plugins/changelog-recent.jssrc/components/Homepage/RecentChangelog.jsxsrc/components/Homepage/RecentChangelog.module.css
🚧 Files skipped from review as they are similar to previous changes (1)
- src/components/Homepage/RecentChangelog.module.css
Comment on lines
+35
to
+42
| if (frontmatter.date) { | ||
| date = new Date(frontmatter.date).toISOString().split("T")[0]; | ||
| } else { | ||
| const dateMatch = file.match(/^(\d{4}-\d{2}-\d{2})/); | ||
| if (dateMatch) { | ||
| date = dateMatch[1]; | ||
| } | ||
| } |
There was a problem hiding this comment.
El parseo de fecha puede lanzar una excepción si frontmatter.date es inválido.
Si frontmatter.date contiene un valor que new Date() no puede parsear correctamente (por ejemplo, un string corrupto o formato inesperado), toISOString() va a explotar como una piña contra la pared. Mejor blindar esto:
🛡️ Propuesta para manejar fechas inválidas
let date = "";
if (frontmatter.date) {
- date = new Date(frontmatter.date).toISOString().split("T")[0];
+ const parsed = new Date(frontmatter.date);
+ if (!isNaN(parsed.getTime())) {
+ date = parsed.toISOString().split("T")[0];
+ }
+ }
+ // Fallback to filename if frontmatter date is missing or invalid
+ if (!date) {
const dateMatch = file.match(/^(\d{4}-\d{2}-\d{2})/);
if (dateMatch) {
date = dateMatch[1];
}
}
- } else {
- const dateMatch = file.match(/^(\d{4}-\d{2}-\d{2})/);
- if (dateMatch) {
- date = dateMatch[1];
- }
- }📝 Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
Suggested change
| if (frontmatter.date) { | |
| date = new Date(frontmatter.date).toISOString().split("T")[0]; | |
| } else { | |
| const dateMatch = file.match(/^(\d{4}-\d{2}-\d{2})/); | |
| if (dateMatch) { | |
| date = dateMatch[1]; | |
| } | |
| } | |
| if (frontmatter.date) { | |
| const parsed = new Date(frontmatter.date); | |
| if (!isNaN(parsed.getTime())) { | |
| date = parsed.toISOString().split("T")[0]; | |
| } | |
| } | |
| // Fallback to filename if frontmatter date is missing or invalid | |
| if (!date) { | |
| const dateMatch = file.match(/^(\d{4}-\d{2}-\d{2})/); | |
| if (dateMatch) { | |
| date = dateMatch[1]; | |
| } | |
| } |
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.
In `@plugins/changelog-recent.js` around lines 35 - 42, El bloque que convierte
frontmatter.date a ISO puede lanzar si el valor es inválido; en la rama donde
usas frontmatter.date crea un Date object (e.g., const parsed = new
Date(frontmatter.date)), verifica su validez con isNaN(parsed.getTime()) (o
Date.parse) antes de llamar a parsed.toISOString(), y si es inválido o lanza,
cae al fallback existente que usa file.match(/^(\d{4}-\d{2}-\d{2})/) o deja date
undefined; envuelve la conversión en un try/catch para evitar excepciones y
actualiza la asignación de date solo cuando la fecha es válida (referencias:
frontmatter.date, new Date(...).toISOString(), parsed.getTime(), file.match).
Comment on lines
86
to
+92
| export default function RecentChangelog() { | ||
| const { recentChangelogs } = usePluginData("changelog-recent"); | ||
| const { i18n: { currentLocale } } = useDocusaurusContext(); | ||
|
|
||
| if (!recentChangelogs || recentChangelogs.length === 0) { | ||
| return null; | ||
| } |
There was a problem hiding this comment.
Potencial error de destructuring si el plugin no devuelve datos.
Si usePluginData("changelog-recent") devuelve undefined (por ejemplo, si el plugin falla o no está registrado), la destructuración const { recentChangelogs } = ... va a explotar. Mejor darle una piña defensiva:
🛡️ Propuesta de manejo defensivo
export default function RecentChangelog() {
- const { recentChangelogs } = usePluginData("changelog-recent");
+ const pluginData = usePluginData("changelog-recent") || {};
+ const { recentChangelogs } = pluginData;
const { i18n: { currentLocale } } = useDocusaurusContext();
if (!recentChangelogs || recentChangelogs.length === 0) {
return null;
}📝 Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
Suggested change
| export default function RecentChangelog() { | |
| const { recentChangelogs } = usePluginData("changelog-recent"); | |
| const { i18n: { currentLocale } } = useDocusaurusContext(); | |
| if (!recentChangelogs || recentChangelogs.length === 0) { | |
| return null; | |
| } | |
| export default function RecentChangelog() { | |
| const pluginData = usePluginData("changelog-recent") || {}; | |
| const { recentChangelogs } = pluginData; | |
| const { i18n: { currentLocale } } = useDocusaurusContext(); | |
| if (!recentChangelogs || recentChangelogs.length === 0) { | |
| return null; | |
| } |
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.
In `@src/components/Homepage/RecentChangelog.jsx` around lines 86 - 92,
RecentChangelog currently destructures directly from
usePluginData("changelog-recent") (and from useDocusaurusContext().i18n) which
will throw if those return undefined; fix by first assigning pluginData =
usePluginData("changelog-recent") || {} and context = useDocusaurusContext() ||
{} then safely extract recentChangelogs and i18n.currentLocale (e.g., const {
recentChangelogs } = pluginData; const { i18n = {} } = context; const {
currentLocale } = i18n) so the component returns null safely when data is
missing without runtime errors.
There was a problem hiding this comment.
♻️ Duplicate comments (1)
i18n/es/docusaurus-plugin-content-docs/current/cli.mdx (1)
201-203:⚠️ Potential issue | 🟡 MinorCorrige el placeholder del comando para evitar copia/pega erróneo.
En Line 201,
sleakops sub-command --helpparece un comando real y puede confundir. Mejor dejar un placeholder explícito (<sub-command>) o comandos concretos.💥 Cambio propuesto
-Este mensaje aparece cuando tenés varios proyectos con el mismo nombre en distintos entornos. Para resolverlo, especificá el entorno usando el parámetro `-e` o `--environment` en tus comandos de build o deploy. Si necesitás más información sobre las opciones de este comando, ejecutá `sleakops sub-command --help`. +Este mensaje aparece cuando tenés varios proyectos con el mismo nombre en distintos entornos. Para resolverlo, especificá el entorno usando el parámetro `-e` o `--environment` en tus comandos de build o deploy. Si necesitás más información sobre las opciones de este comando, ejecutá `sleakops <sub-command> --help`.🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@i18n/es/docusaurus-plugin-content-docs/current/cli.mdx` around lines 201 - 203, Replace the ambiguous literal "sleakops sub-command --help" with an explicit placeholder or concrete examples to avoid copy/paste mistakes; update the text in the CLI docs (the paragraph referencing the help command) to use either "sleakops <sub-command> --help" or show real commands like "sleakops build --help" and "sleakops deploy --help" so readers clearly know how to obtain help for specific subcommands.
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.
Duplicate comments:
In `@i18n/es/docusaurus-plugin-content-docs/current/cli.mdx`:
- Around line 201-203: Replace the ambiguous literal "sleakops sub-command
--help" with an explicit placeholder or concrete examples to avoid copy/paste
mistakes; update the text in the CLI docs (the paragraph referencing the help
command) to use either "sleakops <sub-command> --help" or show real commands
like "sleakops build --help" and "sleakops deploy --help" so readers clearly
know how to obtain help for specific subcommands.
ℹ️ Review info
⚙️ Run configuration
Configuration used: Organization UI
Review profile: CHILL
Plan: Pro
Run ID: 2355e9e7-d48c-4119-8320-9b5eea8843ab
📒 Files selected for processing (43)
content/docs/en/changelog.mdxcontent/docs/en/cli.mdxcontent/docs/en/cluster/index.mdxcontent/docs/en/connect_to_git.mdxcontent/docs/en/domain/index.mdxcontent/docs/en/environment/index.mdxcontent/docs/en/network/index.mdxcontent/docs/en/project/index.mdxcontent/docs/en/provider/index.mdxcontent/docs/en/responsability-model.mdxcontent/docs/en/user/index.mdxcontent/docs/es/changelog.mdxcontent/docs/es/cli.mdxcontent/docs/es/cluster/index.mdxcontent/docs/es/connect_to_git.mdxcontent/docs/es/domain/index.mdxcontent/docs/es/environment/index.mdxcontent/docs/es/network/index.mdxcontent/docs/es/project/index.mdxcontent/docs/es/provider/index.mdxcontent/docs/es/responsability-model.mdxcontent/docs/es/user/index.mdxdocs/cluster/index.mdxdocs/connect_to_git.mdxdocs/domain/index.mdxdocs/environment/index.mdxdocs/network/index.mdxdocs/project/index.mdxdocs/provider/index.mdxdocs/responsability-model.mdxdocs/user/index.mdxi18n/es/docusaurus-plugin-content-docs/current/changelog.mdxi18n/es/docusaurus-plugin-content-docs/current/cli.mdxi18n/es/docusaurus-plugin-content-docs/current/cluster/index.mdxi18n/es/docusaurus-plugin-content-docs/current/connect_to_git.mdxi18n/es/docusaurus-plugin-content-docs/current/domain/index.mdxi18n/es/docusaurus-plugin-content-docs/current/environment/index.mdxi18n/es/docusaurus-plugin-content-docs/current/network/index.mdxi18n/es/docusaurus-plugin-content-docs/current/project/index.mdxi18n/es/docusaurus-plugin-content-docs/current/provider/index.mdxi18n/es/docusaurus-plugin-content-docs/current/responsability-model.mdxi18n/es/docusaurus-plugin-content-docs/current/user/index.mdxsidebars.js
✅ Files skipped from review due to trivial changes (40)
- content/docs/es/cli.mdx
- content/docs/es/environment/index.mdx
- content/docs/es/user/index.mdx
- content/docs/en/provider/index.mdx
- content/docs/en/project/index.mdx
- content/docs/en/environment/index.mdx
- content/docs/en/cluster/index.mdx
- content/docs/en/network/index.mdx
- content/docs/en/changelog.mdx
- content/docs/en/domain/index.mdx
- content/docs/es/project/index.mdx
- content/docs/en/responsability-model.mdx
- content/docs/en/user/index.mdx
- content/docs/es/changelog.mdx
- docs/provider/index.mdx
- docs/domain/index.mdx
- content/docs/es/responsability-model.mdx
- docs/responsability-model.mdx
- docs/user/index.mdx
- content/docs/en/cli.mdx
- i18n/es/docusaurus-plugin-content-docs/current/environment/index.mdx
- docs/connect_to_git.mdx
- content/docs/es/provider/index.mdx
- docs/environment/index.mdx
- i18n/es/docusaurus-plugin-content-docs/current/connect_to_git.mdx
- content/docs/es/connect_to_git.mdx
- docs/network/index.mdx
- i18n/es/docusaurus-plugin-content-docs/current/cluster/index.mdx
- i18n/es/docusaurus-plugin-content-docs/current/domain/index.mdx
- i18n/es/docusaurus-plugin-content-docs/current/changelog.mdx
- i18n/es/docusaurus-plugin-content-docs/current/project/index.mdx
- content/docs/en/connect_to_git.mdx
- i18n/es/docusaurus-plugin-content-docs/current/responsability-model.mdx
- i18n/es/docusaurus-plugin-content-docs/current/network/index.mdx
- docs/cluster/index.mdx
- docs/project/index.mdx
- i18n/es/docusaurus-plugin-content-docs/current/provider/index.mdx
- content/docs/es/network/index.mdx
- content/docs/es/domain/index.mdx
- i18n/es/docusaurus-plugin-content-docs/current/user/index.mdx
🚧 Files skipped from review as they are similar to previous changes (1)
- content/docs/es/cluster/index.mdx
mjroson
pushed a commit
that referenced
this pull request
Mar 21, 2026
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary by CodeRabbit
New Features
Documentation
Chores