docs(arch): documentação de Arquitetura C4 (DevPortal + Wiki)#288
Merged
Conversation
…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>
|
Important Review skippedDraft detected. Please check the settings in the CodeRabbit UI or the ⚙️ Run configurationConfiguration used: defaults Review profile: CHILL Plan: Pro Run ID: You can disable this status message by setting the Use the checkbox below for a quick retry:
✨ 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 |
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
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.
📋 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
frontend/devportal/architecture/— auto-contido (HTML + bundle do design system +support.js). Espelhado embackend/Arah.Api/wwwroot/devportal/architecture/para ser servido pela API em/devportal/architecture/.frontend/devportal/index.html), ao lado do link do Wiki.docs/14_C4_ARCHITECTURE.mdcom 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.frontend/wiki/public/architecture/*.webp.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 emhttps://devportal.arah.app/wiki/docs/14_C4_ARCHITECTURE/.🔄 Tipo de Mudança
🧪 Testes
npm run type-check(wiki) — sem errosnpm run generate-search-index— 491 docs indexados (inclui14_C4_ARCHITECTURE)npm run buildeNEXT_EXPORT=true npm run build(wiki) — 497 páginas;out/docs/14_C4_ARCHITECTURE/eout/architecture/*.webpgerados, refs/wiki/architecture/*.webpcorretas/architecture/) — todos os diagramas C4 carregamWalkthrough
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 wikidocs/10_ARCHITECTURE_DECISIONS.md— referência corrigida para o doc C4frontend/devportal/ebackend/Arah.Api/wwwroot/devportal/— documento interativo + linkTo show artifacts inline, enable in settings.