feat(reversa): enhance main entry point description and add chat comm… - #25
feat(reversa): enhance main entry point description and add chat comm…#25padsdev wants to merge 2 commits into
Conversation
…and handling Updated the main entry point description to include additional chat command shortcuts for better user interaction. Enhanced the activation flow to handle chat commands without restarting the discovery pipeline. Added detailed instructions for generating and updating the documentation index and recording the doc↔code baseline after pipeline completion. Updated related documentation across multiple languages to reflect these changes.
![chatgpt-codex-connector[bot]](https://avatars.githubusercontent.com/in/1144995?s=60&v=4){kind=small}
There was a problem hiding this comment.
💡 Codex Review
Here are some automated review suggestions for this pull request.
Reviewed commit: 5abda889bc
ℹ️ About Codex in GitHub
Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you
- Open a pull request for review
- Mark a draft as ready
- Comment "@codex review".
If Codex has suggestions, it will comment; otherwise it will react with 👍.
Codex can also answer questions or update the PR. Try commenting "@codex address that feedback".
| 1. Se `_reversa_sdd/` não existir: avise e pare. | ||
| 2. Se `README.md` já existir: leia e **preserve** a seção `## Sincronização doc ↔ código` inteira. | ||
| 3. Regenere as demais seções a partir do template `references/README.indice.template.md` e do inventário real em `_reversa_sdd/`. |
There was a problem hiding this comment.
For projects installed with a non-default specs folder, the installer stores that choice in .reversa/state.json/config.toml (output_folder), but this new indice procedure only checks and inventories _reversa_sdd/. In that configuration, indice/atualizar --baseline will either stop even though the real docs folder exists, or build the sync README from the wrong directory, so the doc↔code baseline is not recorded for the actual generated specs. Please resolve the output directory from state.output_folder (defaulting to _reversa_sdd) throughout this step.
Useful? React with 👍 / 👎.
There was a problem hiding this comment.
Pull request overview
This PR addresses Issue #18 by formalizing an incremental “doc↔code baseline” workflow and exposing chat shortcuts so users can update generated SDD documentation based on git commit SHAs without restarting the full discovery pipeline.
Changes:
- Extends the main Reversa orchestrator skill to recognize chat commands (
indice,atualizar,atualizar --baseline, etc.) and to record a centralized doc-sync baseline in.reversa/doc-sync.json. - Adds the detailed doc-sync procedure reference (
step-doc-sync.md) plus an index README template for_reversa_sdd/README.md(including an append-only sync table). - Updates user-facing documentation (PT/EN/ES) to mention the new index README output and the orchestrator chat shortcuts.
Reviewed changes
Copilot reviewed 13 out of 13 changed files in this pull request and generated 3 comments.
Show a summary per file
| File | Description |
|---|---|
| docs/saidas/index.pt.md | Documents _reversa_sdd/README.md as part of the generated output structure (PT). |
| docs/saidas/index.md | Documents _reversa_sdd/README.md as part of the generated output structure (EN). |
| docs/saidas/index.es.md | Documents _reversa_sdd/README.md as part of the generated output structure (ES). |
| docs/cli.pt.md | Adds a section documenting orchestrator chat shortcuts (PT). |
| docs/cli.md | Adds a section documenting orchestrator chat shortcuts (EN). |
| docs/cli.es.md | Adds a section documenting orchestrator chat shortcuts (ES). |
| docs/agentes/reversa.pt.md | Documents new responsibilities + chat command table for the orchestrator (PT). |
| docs/agentes/reversa.md | Documents new responsibilities + chat command table for the orchestrator (EN). |
| docs/agentes/reversa.es.md | Documents new responsibilities + chat command table for the orchestrator (ES). |
| agents/reversa/SKILL.md | Updates Reversa entrypoint behavior to handle chat commands and doc-sync baseline recording. |
| agents/reversa/references/step-doc-sync.md | Adds the canonical procedure/spec for baseline recording and incremental updates. |
| agents/reversa/references/step-04-regression-check.md | Ensures indice + doc-sync baseline are executed before declaring extraction complete. |
| agents/reversa/references/README.indice.template.md | Adds the template used by indice to generate/update _reversa_sdd/README.md. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
| | `atualizar [unit]` | Same flow, scoped to one unit | | ||
| | `atualizar --baseline` | Record HEAD as the initial baseline in `.reversa/doc-sync.json` | | ||
|
|
||
| The doc↔code baseline lives in `.reversa/doc-sync.json` and in the append-only **Sincronização doc ↔ código** table of the index README — not in every spec file. |
| | `atualizar [unidad]` | Mismo flujo, acotado a una unidad | | ||
| | `atualizar --baseline` | Graba el HEAD como marco inicial en `.reversa/doc-sync.json` | | ||
|
|
||
| El marco doc↔código queda en `.reversa/doc-sync.json` y en el historial append-only de la tabla **Sincronização doc ↔ código** del README índice — no en cada archivo de spec. |
Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>
Issue Relacionada
Resolve / Referencia: #18
Resumo das Alterações
Atualizada a descrição do ponto de entrada (entry point) principal para incluir atalhos adicionais de comandos de chat, visando uma melhor interação do usuário.
Aprimorado o fluxo de ativação para lidar com os comandos de chat sem a necessidade de reiniciar o pipeline de descoberta.
Adicionadas instruções detalhadas para a geração e atualização do índice da documentação, além do registro da baseline doc↔código após a conclusão do pipeline.
Atualizada a documentação relacionada em múltiplos idiomas para refletir essas mudanças.
Objetivo Principal
A ideia central desta implementação é permitir explicitamente que o usuário possa atualizar a documentação com base no hash de commit da documentação gerada.