Skip to content

docs(arch): documentação de Arquitetura C4 (DevPortal + Wiki)#288

Merged
cursor[bot] merged 1 commit into
mainfrom
cursor/arquitetura-c4-docs-1c6f
Jun 29, 2026
Merged

docs(arch): documentação de Arquitetura C4 (DevPortal + Wiki)#288
cursor[bot] merged 1 commit into
mainfrom
cursor/arquitetura-c4-docs-1c6f

Conversation

@sraphaz

@sraphaz sraphaz commented Jun 29, 2026

Copy link
Copy Markdown
Owner

📋 Descrição

Adiciona a documentação de Arquitetura C4 da plataforma Arah (recém-criada) ao projeto e a referencia tanto no site técnico (DevPortal) quanto no Wiki.

O que foi adicionado

  • Documento interativo C4 (Contexto, Containers, Componentes do App e da API, mapa de domínios, implantação e diagramas de sequência de funcionalidades implementadas e previstas) em frontend/devportal/architecture/ — auto-contido (HTML + bundle do design system + support.js). Espelhado em backend/Arah.Api/wwwroot/devportal/architecture/ para ser servido pela API em /devportal/architecture/.
  • Link "Arquitetura C4" no header do DevPortal (frontend/devportal/index.html), ao lado do link do Wiki.
  • Nova página no Wiki: docs/14_C4_ARCHITECTURE.md com resumo dos níveis C4, diagramas embutidos (capturados do documento interativo) e link para a versão navegável. Integrada na sidebar (Sidebar.tsx) e no índice de docs (app/docs/page.tsx); indexada na busca.
  • Diagramas em frontend/wiki/public/architecture/*.webp.
  • Corrige a referência de Arquitetura C4 em docs/10_ARCHITECTURE_DECISIONS.md (apontava para um caminho que não resolvia no wiki) para o novo doc.

Publicação (GitHub Pages): o documento fica em https://devportal.arah.app/architecture/ e a página do wiki em https://devportal.arah.app/wiki/docs/14_C4_ARCHITECTURE/.

🔄 Tipo de Mudança

  • Mudança em documentação

🧪 Testes

  • npm run type-check (wiki) — sem erros
  • npm run generate-search-index — 491 docs indexados (inclui 14_C4_ARCHITECTURE)
  • npm run build e NEXT_EXPORT=true npm run build (wiki) — 497 páginas; out/docs/14_C4_ARCHITECTURE/ e out/architecture/*.webp gerados, refs /wiki/architecture/*.webp corretas
  • ✅ Render do documento interativo no navegador (/architecture/) — todos os diagramas C4 carregam
  • ✅ Render da página do wiki — título, diagramas embutidos e link para o DevPortal presentes; entrada na sidebar "Arquitetura"

Walkthrough

Documento interativo C4 (DevPortal):
C4 Contexto
C4 Containers
Mapa de domínios

Página no Wiki referenciando a arquitetura:
Página Arquitetura C4 no Wiki
Diagramas de componentes embutidos no Wiki

📝 Lista de Documentos Atualizados

  • docs/14_C4_ARCHITECTURE.md (novo) — página C4 do wiki
  • docs/10_ARCHITECTURE_DECISIONS.md — referência corrigida para o doc C4
  • frontend/devportal/ e backend/Arah.Api/wwwroot/devportal/ — documento interativo + link

To show artifacts inline, enable in settings.

Open in Web Open in Cursor 

…evportal

- Adiciona documento interativo C4 (Contexto, Containers, Componentes, mapa de dominios, sequencias) em frontend/devportal/architecture/ (espelhado em wwwroot para a API)
- Link 'Arquitetura C4' no header do DevPortal
- Nova pagina docs/14_C4_ARCHITECTURE.md no wiki com resumo e diagramas, wired na sidebar e no indice de docs
- Atualiza referencia em 10_ARCHITECTURE_DECISIONS.md para o novo doc C4
- Diagramas (webp) em frontend/wiki/public/architecture/

Co-authored-by: Rapha <sraphaz@users.noreply.github.com>
@coderabbitai

coderabbitai Bot commented Jun 29, 2026

Copy link
Copy Markdown

Important

Review skipped

Draft detected.

Please check the settings in the CodeRabbit UI or the .coderabbit.yaml file in this repository. To trigger a single review, invoke the @coderabbitai review command.

⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro

Run ID: edefe4ea-3646-4e53-b551-9c5035d85105

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

Use the checkbox below for a quick retry:

  • 🔍 Trigger review
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch cursor/arquitetura-c4-docs-1c6f

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.

@cursor cursor Bot merged commit 6247f4a into main Jun 29, 2026
5 checks 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