docs: sync CLI reference and intro with codebase#154
Conversation
✅ Snyk checks have passed. No issues have been found so far.
💻 Catch issues earlier using the plugins for VS Code, JetBrains IDEs, Visual Studio, and Eclipse. |
Deploying corvus with
|
| Latest commit: |
2352e77
|
| Status: | ✅ Deploy successful! |
| Preview URL: | https://91b6046a.corvus-42x.pages.dev |
| Branch Preview URL: | https://docs-sync-cli-and-intro.corvus-42x.pages.dev |
|
Warning Rate limit exceeded
⌛ How to resolve this issue?After the wait time has elapsed, a review can be triggered using the We recommend that you space out your commits to avoid hitting the rate limit. 🚦 How do rate limits work?CodeRabbit enforces hourly rate limits for each developer per organization. Our paid plans have higher rate limits than the trial, open-source and free plans. In all cases, we re-allow further reviews after a brief timeout. Please see our FAQ for further information. ⚙️ Run configurationConfiguration used: Path: .coderabbit.yaml Review profile: ASSERTIVE Plan: Pro Run ID: 📒 Files selected for processing (2)
📝 WalkthroughWalkthroughThis pull request updates project documentation and a scribe journal entry. Changes include refreshing the README build commands, expanding CLI reference documentation with a new peripheral port flag and update command group, and comprehensively reworking introduction pages in both English and Spanish with new sections on features, tech stack, and project structure. Changes
Estimated code review effort🎯 2 (Simple) | ⏱️ ~12 minutes Possibly related PRs
Suggested labels
Suggested reviewers
🚥 Pre-merge checks | ✅ 3✅ Passed checks (3 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches🧪 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 |
✅ Contributor ReportUser: @yacosta738
Contributor Report evaluates based on public GitHub activity. Analysis period: 2025-03-07 to 2026-03-07 |
Codecov Report✅ All modified and coverable lines are covered by tests. 📢 Thoughts on this report? Let us know! |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
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 @.agents/journal/scribe-journal.md:
- Around line 119-144: The journal entry heading "## 2026-03-06 - Documentation
Review & Sync - COMPLETE" is out of chronological order (appears after "##
2026-05-22 - CLI Reference Audit & Update - COMPLETE"); move the entire March 6
block (from its heading through the end of that entry) so it appears before the
"## 2026-05-22 - CLI Reference Audit & Update - COMPLETE" heading, or
alternately reorder the file to a consistent newest-first sort so all entries
(including the March 6 entry) are in proper chronological order; update only
.agents/journal/scribe-journal.md and ensure headings and relative formatting
remain unchanged.
In `@clients/web/apps/docs/src/content/docs/es/intro/introduction.mdx`:
- Around line 21-28: Translate the remaining English labels in the section so
the Spanish localization is consistent: change the heading "## 🛠️ Tech Stack"
to "## 🛠️ Pila tecnológica" (or "Pila tecnológica"), replace "- **Lógica
Core**" with "- **Núcleo de Lógica**" (or "Núcleo de la lógica"), and change "-
**Web Stack**" to "- **Pila web**"; keep or adjust other entries ("Runtime de
Agente", "UI de Escritorio", "Documentación", "Sistema de Construcción") to
fully Spanish phrasing if any English remnants remain so the list items under
the "Tech Stack" heading are entirely localized. Ensure the edited strings are
updated in the same block containing "## 🛠️ Tech Stack" and the corresponding
list items.
ℹ️ Review info
⚙️ Run configuration
Configuration used: Path: .coderabbit.yaml
Review profile: ASSERTIVE
Plan: Pro
Run ID: c10d830c-8beb-4c64-94ff-5ba565fbd00a
⛔ Files ignored due to path filters (1)
clients/web/apps/docs/src/assets/corvus.pngis excluded by!**/*.png
📒 Files selected for processing (6)
.agents/journal/scribe-journal.mdREADME.mdclients/web/apps/docs/src/content/docs/en/guides/cli-reference.mdclients/web/apps/docs/src/content/docs/en/intro/introduction.mdxclients/web/apps/docs/src/content/docs/es/guides/cli-reference.mdclients/web/apps/docs/src/content/docs/es/intro/introduction.mdx
📜 Review details
⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (3)
- GitHub Check: sonar
- GitHub Check: pr-checks-build-logic
- GitHub Check: Cloudflare Pages
🧰 Additional context used
📓 Path-based instructions (2)
**/*.{md,mdx}
⚙️ CodeRabbit configuration file
**/*.{md,mdx}: Verify technical accuracy and that docs stay aligned with code changes.
For user-facing docs, check EN/ES parity or explicitly note pending translation gaps.
Files:
clients/web/apps/docs/src/content/docs/en/guides/cli-reference.mdclients/web/apps/docs/src/content/docs/es/intro/introduction.mdxREADME.mdclients/web/apps/docs/src/content/docs/en/intro/introduction.mdxclients/web/apps/docs/src/content/docs/es/guides/cli-reference.md
**/*
⚙️ CodeRabbit configuration file
**/*: Security first, performance second.
Validate input boundaries, auth/authz implications, and secret management.
Look for behavioral regressions, missing tests, and contract breaks across modules.
Files:
clients/web/apps/docs/src/content/docs/en/guides/cli-reference.mdclients/web/apps/docs/src/content/docs/es/intro/introduction.mdxREADME.mdclients/web/apps/docs/src/content/docs/en/intro/introduction.mdxclients/web/apps/docs/src/content/docs/es/guides/cli-reference.md
🧠 Learnings (3)
📚 Learning: 2026-02-17T07:28:38.934Z
Learnt from: CR
Repo: dallay/corvus PR: 0
File: AGENTS.md:0-0
Timestamp: 2026-02-17T07:28:38.934Z
Learning: Applies to .agents/AGENTS.md : Document agent configurations and capabilities in AGENTS.md
Applied to files:
clients/web/apps/docs/src/content/docs/en/intro/introduction.mdx
📚 Learning: 2026-02-17T07:28:38.934Z
Learnt from: CR
Repo: dallay/corvus PR: 0
File: AGENTS.md:0-0
Timestamp: 2026-02-17T07:28:38.934Z
Learning: Applies to .agents/AGENTS.md : Maintain comprehensive agent metadata including name, description, purpose, and capabilities
Applied to files:
clients/web/apps/docs/src/content/docs/en/intro/introduction.mdx
📚 Learning: 2026-02-21T09:07:52.298Z
Learnt from: yacosta738
Repo: dallay/corvus PR: 62
File: .agents/journal/sentinnel-journal.md:1-1
Timestamp: 2026-02-21T09:07:52.298Z
Learning: Branding guideline: The intentional brand name for the security-first agent in the dallay/corvus repository is 'Sentinnel' (with double n). Do not treat it as a typo of 'Sentinel'. Ensure all agent-related docs and journals under .agents/journal consistently use 'Sentinnel' with double n.
Applied to files:
.agents/journal/scribe-journal.md
🪛 LanguageTool
clients/web/apps/docs/src/content/docs/es/intro/introduction.mdx
[grammar] ~6-~6: Aquí puede haber un error.
Context: ...entes Corvus. --- # Bienvenido a Corvus Corvus es una plataforma agéntica alta...
(QB_NEW_ES)
[grammar] ~14-~14: Cambia la palabra o signo.
Context: ...png) ## ✨ Características - Soporte Multi-Interfaz: Interactúa con Corvus a través de la...
(QB_NEW_ES_OTHER_ERROR_IDS_REPLACEMENT_OTHER)
[grammar] ~15-~15: Agrega una palabra o signo.
Context: ...platform o un panel de control web. - Autonomía Siempre Activa: Un modo demonio para ...
(QB_NEW_ES_OTHER_ERROR_IDS_MISSING_OTHER)
[grammar] ~16-~16: Agrega una palabra o signo.
Context: ...o plano y orquestación persistente. - Sandboxing Seguro: Ejecuta comandos peligrosos d...
(QB_NEW_ES_OTHER_ERROR_IDS_MISSING_OTHER)
[grammar] ~16-~16: Corrige la mayúscula.
Context: ...rquestación persistente. - Sandboxing Seguro: Ejecuta comandos peligrosos de forma...
(QB_NEW_ES_OTHER_ERROR_IDS_REPLACEMENT_ORTHOGRAPHY_UPPERCASE)
[grammar] ~17-~17: Agrega una palabra o signo.
Context: ...os o runtimes nativos restringidos. - Identidad Estandarizada (AIEOS): Soporte para A...
(QB_NEW_ES_OTHER_ERROR_IDS_MISSING_OTHER)
[grammar] ~19-~19: Agrega una palabra o signo.
Context: ...para recuperación de alto contexto. - Integraciones Ricas: Soporte de primera clase para ...
(QB_NEW_ES_OTHER_ERROR_IDS_MISSING_OTHER)
[grammar] ~19-~19: Corrige la mayúscula.
Context: ...ión de alto contexto. - Integraciones Ricas: Soporte de primera clase para WhatsA...
(QB_NEW_ES_OTHER_ERROR_IDS_REPLACEMENT_ORTHOGRAPHY_UPPERCASE)
[grammar] ~23-~23: Oración con errores
Context: ...gica Core**: Kotlin Multiplatform (KMP) - Runtime de Agente: [Rust](https://www....
(QB_NEW_ES_OTHER_ERROR_IDS_REPLACEMENT_MULTITOKEN)
[grammar] ~24-~24: Cambia la palabra o signo.
Context: ...g/) (Sidecars de alto rendimiento y CLI) - UI de Escritorio: [Compose Multiplatfo...
(QB_NEW_ES_OTHER_ERROR_IDS_REPLACEMENT_SPACE)
[grammar] ~25-~25: Cambia la palabra o signo.
Context: ... de Escritorio**: Compose Multiplatform - Web Stack: [Astro](https://astro.build...
(QB_NEW_ES_OTHER_ERROR_IDS_REPLACEMENT_OTHER)
[grammar] ~26-~26: Cambia la palabra o signo.
Context: ...e 3](https://vuejs.org/) y Tailwind CSS - Documentación: [Starlight](https://sta...
(QB_NEW_ES_OTHER_ERROR_IDS_REPLACEMENT_OTHER)
[grammar] ~27-~27: Cambia la palabra o signo.
Context: ...om/docs) - Documentación: Starlight - Sistema de Construcción: [Gradle](http...
(QB_NEW_ES_OTHER_ERROR_IDS_REPLACEMENT_OTHER)
[grammar] ~28-~28: Aquí puede haber un error.
Context: ...) - Sistema de Construcción: Gradle y Makefile ## 📂 Estructura del Proyecto Este reposit...
(QB_NEW_ES)
[grammar] ~30-~30: Aquí puede haber un error.
Context: ...g/software/make/) ## 📂 Estructura del Proyecto Este repositorio está organizado como un...
(QB_NEW_ES)
[grammar] ~49-~49: Corrige la mayúscula.
Context: ...tareas de desarrollo ``` ## Siguientes Pasos ¿Listo para empezar? - **[Primeros Paso...
(QB_NEW_ES_OTHER_ERROR_IDS_REPLACEMENT_ORTHOGRAPHY_UPPERCASE)
[grammar] ~53-~53: Agrega una palabra o signo.
Context: ...entes Pasos ¿Listo para empezar? - Primeros Pasos: I...
(QB_NEW_ES_OTHER_ERROR_IDS_MISSING_OTHER)
[grammar] ~54-~54: Agrega una palabra o signo.
Context: ...nstala y ejecuta tu primer agente. - Referencia de la CLI:...
(QB_NEW_ES_OTHER_ERROR_IDS_MISSING_OTHER)
[grammar] ~54-~54: Cambia el sustantivo.
Context: ...tu primer agente. - Referencia de la CLI: Domina la...
(QB_NEW_ES_OTHER_ERROR_IDS_REPLACEMENT_NOUN)
[grammar] ~55-~55: Oración con errores
Context: ... la interfaz de línea de comandos. - Arquitectura: Comprende ...
(QB_NEW_ES_OTHER_ERROR_IDS_REPLACEMENT_MULTITOKEN)
clients/web/apps/docs/src/content/docs/es/guides/cli-reference.md
[grammar] ~270-~270: Elimina la puntuación
Context: ...rvus al Arduino. - -p, --port <PORT>: Puerto serie (si se omite, usa el prime...
(QB_NEW_ES_OTHER_ERROR_IDS_UNNECESSARY_PUNCTUATION)
[grammar] ~270-~270: Expresión incorrecta.
Context: ...us al Arduino. - -p, --port <PORT>: Puerto serie (si se omite, usa el primer arduino-uno...
(ES_SIMPLE_REPLACE_MULTIWORDS_PUERTO_SERIE)
[grammar] ~306-~306: Elimina la puntuación
Context: ...instalación automática. - auto-disable: Deshabilitar política de instalación au...
(QB_NEW_ES_OTHER_ERROR_IDS_UNNECESSARY_PUNCTUATION)
[grammar] ~308-~308: Elimina la puntuación
Context: ... de actualizaciones. - confirm <NONCE>: Confirmar un nonce de confirmación de a...
(QB_NEW_ES_OTHER_ERROR_IDS_UNNECESSARY_PUNCTUATION)
|
1 participant
This pull request delivers a comprehensive documentation review and update across both English and Spanish docs, focusing on improved accuracy, completeness, and clarity. Key changes include the addition of missing CLI commands, enhancements to the introduction with project-specific details, corrections to build instructions, and improved asset handling for images.
Documentation Accuracy and Completeness:
updatecommand (with all subcommands and examples) to both English and Spanish CLI reference guides, ensuring parity with the actual CLI capabilities. [1] [2]flashperipheral command to include the-p/--portoption in both English and Spanish guides. [1] [2]Introduction and Project Overview:
introduction.mdxfiles with detailed, project-specific descriptions, including a feature summary, tech stack, and monorepo structure. [1] [2]corvus.png.Build and Usage Instructions:
README.mdto usemake docs-buildandmake docs-dev, reflecting the actual Makefile targets. [1] [2]Meta/Process Improvements:
make docs-checkandmake docs-build.These updates ensure that users and contributors have up-to-date, clear, and actionable documentation for getting started and using the Corvus Agent Platform.