Skip to content

feat: add activitylog docs and update provider#167

Merged
lucaiz merged 3 commits intodevelopfrom
feat/SLEAK-4557-activity-log-docs
Apr 7, 2026
Merged

feat: add activitylog docs and update provider#167
lucaiz merged 3 commits intodevelopfrom
feat/SLEAK-4557-activity-log-docs

Conversation

@gonferreyra
Copy link
Copy Markdown
Contributor

@gonferreyra gonferreyra commented Apr 7, 2026

Summary by CodeRabbit

  • Documentación
    • Agregada nueva documentación del "Registro de Actividad" con descripción completa de funcionalidades, columnas de tabla y capacidades de filtrado, disponible en inglés y español.
    • Actualizada documentación de configuración de proveedores con instrucciones de navegación mejoradas y clarificación sobre redirección al panel de control tras completar el proceso.

@coderabbitai
Copy link
Copy Markdown

coderabbitai bot commented Apr 7, 2026

Recorrido

Se añadieron nuevas páginas de documentación sobre el Registro de Actividad en inglés y español, con secciones detalladas sobre acceso, columnas de tabla y capacidades de filtrado. Además, se actualizaron textos instructivos en documentación de proveedores en ambos idiomas para mejorar claridad y consistencia.

Cambios

Cohort / Archivo(s) Resumen
Documentación de Registro de Actividad
content/docs/en/activitylog.mdx, content/docs/es/activitylog.mdx
Nuevas páginas de documentación introduciendo el Registro de Actividad con descripciones de qué se registra, recursos rastreados, navegación a detalles, acceso desde el dashboard, estructura de tabla y opciones de filtrado con imágenes ampliables.
Documentación de Proveedores
content/docs/en/provider/index.mdx, content/docs/es/provider/index.mdx
Actualizaciones de redacción instructiva para mayor claridad ("Left Pane" → "Left Panel", "Setting" → "Settings") y adición de confirmación de redirección al dashboard tras completar el proceso.

Esfuerzo estimado de revisión de código

🎯 1 (Trivial) | ⏱️ ~3 minutos

Revisores sugeridos

  • agustinoli

Poema

📚✨ ¡Documentación a las piñas!

Nuevas páginas florecer,
Actividad registrada, clara y brillante,
En dos idiomas, sin conflicto,
Proveedores mejor guiados,
¡Arreglamos todo con piña! 🍍

🚥 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 los cambios principales: agregar documentación de activitylog y actualizar documentación de provider en ambos idiomas.
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
  • Commit unit tests in branch feat/SLEAK-4557-activity-log-docs

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
Copy Markdown

@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: 2

🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.

Inline comments:
In `@content/docs/en/provider/index.mdx`:
- Line 22: The navigation sentence "Into the *Left Panel*, access the *Settings*
option, then *Providers* and lastly, at the top right corner, click on the
*Create* button." reads unnaturally; replace it with a clearer, more direct
instruction such as: "In the left panel, open Settings → Providers, then click
the Create button in the top-right corner." Update this exact sentence in the
document (content line containing the original string) to improve UX and
readability.

In `@content/docs/es/provider/index.mdx`:
- Line 22: En la oración que comienza "En el *Panel Izquierdo*, accede a la
opción *Configuración*, luego *Providers* y por último, en la esquina superior
derecha, haz clic en el botón *Crear*", añade las comas alrededor del inciso
"por último" para que quede "y, por último, en la esquina superior derecha, haz
clic en el botón *Crear*"; busca la cadena completa en
content/docs/es/provider/index.mdx y reemplázala ajustando únicamente la
puntuación.
🪄 Autofix (Beta)

Fix all unresolved CodeRabbit comments on this PR:

  • Push a commit to this branch (recommended)
  • Create a new PR with the fixes

ℹ️ Review info
⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro

Run ID: 7df432b9-aab8-413e-809f-15d94824c776

📥 Commits

Reviewing files that changed from the base of the PR and between 8ddea79 and e1f12fd.

⛔ Files ignored due to path filters (12)
  • static/img/activitylog/activitylog-dashboard-card.png is excluded by !**/*.png
  • static/img/activitylog/activitylog-filters.png is excluded by !**/*.png
  • static/img/activitylog/activitylog-table.png is excluded by !**/*.png
  • static/img/provider/providerconfirmdelete.png is excluded by !**/*.png
  • static/img/provider/providerdelete.png is excluded by !**/*.png
  • static/img/provider/providererroracclimit.png is excluded by !**/*.png
  • static/img/provider/providererrordefault.png is excluded by !**/*.png
  • static/img/provider/providererrornonroot.png is excluded by !**/*.png
  • static/img/provider/providerstep1.png is excluded by !**/*.png
  • static/img/provider/providerstep2.png is excluded by !**/*.png
  • static/img/provider/providerstep3.png is excluded by !**/*.png
  • static/img/provider/providerstep4.png is excluded by !**/*.png
📒 Files selected for processing (4)
  • content/docs/en/activitylog.mdx
  • content/docs/en/provider/index.mdx
  • content/docs/es/activitylog.mdx
  • content/docs/es/provider/index.mdx

### 1. Navigate to the providers section

Into the *Left Pane*, access the *Setting* option and then *Providers* and then, at the top right corner, click on the *Create* button.
Into the *Left Panel*, access the *Settings* option, then *Providers* and lastly, at the top right corner, click on the *Create* button.
Copy link
Copy Markdown

Choose a reason for hiding this comment

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

⚠️ Potential issue | 🟡 Minor

Mejorar redacción en inglés para instrucción de navegación

La frase suena poco natural. Recomiendo una versión más directa para UX de lectura, a las piñas:

✍️ Ajuste propuesto
-Into the *Left Panel*, access the *Settings* option, then *Providers* and lastly, at the top right corner, click on the *Create* button.
+In the *Left Panel*, go to *Settings*, then *Providers*, and finally click the *Create* button in the top-right corner.
📝 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
Into the *Left Panel*, access the *Settings* option, then *Providers* and lastly, at the top right corner, click on the *Create* button.
In the *Left Panel*, go to *Settings*, then *Providers*, and finally click the *Create* button in the top-right corner.
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.

In `@content/docs/en/provider/index.mdx` at line 22, The navigation sentence "Into
the *Left Panel*, access the *Settings* option, then *Providers* and lastly, at
the top right corner, click on the *Create* button." reads unnaturally; replace
it with a clearer, more direct instruction such as: "In the left panel, open
Settings → Providers, then click the Create button in the top-right corner."
Update this exact sentence in the document (content line containing the original
string) to improve UX and readability.

### 1. Navega a la sección de providers

En el *Panel Izquierdo*, accede a la opción *Configuración* y luego *Providers*. En la esquina superior derecha, haz clic en el botón *Crear*.
En el *Panel Izquierdo*, accede a la opción *Configuración*, luego *Providers* y por último, en la esquina superior derecha, haz clic en el botón *Crear*.
Copy link
Copy Markdown

Choose a reason for hiding this comment

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

⚠️ Potential issue | 🟡 Minor

Pulir puntuación del inciso para que quede redondo

Aquí conviene escribir “y, por último,” (coma antes y después del inciso) para que la instrucción fluya mejor. En docs, estos detalles evitan ambigüedad, a las piñas y sin vueltas.

✍️ Ajuste propuesto
-En el *Panel Izquierdo*, accede a la opción *Configuración*, luego *Providers* y por último, en la esquina superior derecha, haz clic en el botón *Crear*.
+En el *Panel Izquierdo*, accede a la opción *Configuración*, luego *Providers* y, por último, en la esquina superior derecha, haz clic en el botón *Crear*.
📝 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
En el *Panel Izquierdo*, accede a la opción *Configuración*, luego *Providers* y por último, en la esquina superior derecha, haz clic en el botón *Crear*.
En el *Panel Izquierdo*, accede a la opción *Configuración*, luego *Providers* y, por último, en la esquina superior derecha, haz clic en el botón *Crear*.
🧰 Tools
🪛 LanguageTool

[grammar] ~22-~22: Agrega un signo de puntuación.
Context: ...ción Configuración, luego Providers y por último, en la esquina superior dere...

(QB_NEW_ES_OTHER_ERROR_IDS_MISSING_PUNCTUATION)

🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.

In `@content/docs/es/provider/index.mdx` at line 22, En la oración que comienza
"En el *Panel Izquierdo*, accede a la opción *Configuración*, luego *Providers*
y por último, en la esquina superior derecha, haz clic en el botón *Crear*",
añade las comas alrededor del inciso "por último" para que quede "y, por último,
en la esquina superior derecha, haz clic en el botón *Crear*"; busca la cadena
completa en content/docs/es/provider/index.mdx y reemplázala ajustando
únicamente la puntuación.

@lucaiz lucaiz merged commit 83dcd0f into develop Apr 7, 2026
1 check passed
@lucaiz lucaiz deleted the feat/SLEAK-4557-activity-log-docs branch April 7, 2026 15:54
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