Skip to main content

Knowledge Base Workspace (tupynambalucas.dev Docs)

O Workspace Knowledge Base gerencia o hub de documentação oficial para o projeto tupynambalucas.dev, conhecido como tupynambalucas.dev Docs. Construído sobre o Docusaurus v3, ele serve como o portal central de desenvolvedores, abrigando diretrizes arquiteturais, guias de estilo, documentos de planejamento de produto e changelogs e roadmaps automatizados de projetos.

Architecture​

O workspace implementa uma separação estrita entre o conteúdo em markdown puro e o mecanismo de renderização do Docusaurus:

knowledge-base/
├── collections/ # Content Sub-domain (Engine-agnostic)
│ └── namespaces/
│ └── portal/
│ └── content/
│ ├── blog/ # Unified blog for regular posts and releases
│ ├── community/ # Community guidelines and contributing docs
│ ├── docs/ # Monorepo architecture and workspace references
│ └── messages/ # Extracted Docusaurus UI JSON templates (Chrome i18n format)
│ ├─ pages/ # Custom React landing pages
├── docusaurus/ # Engine Sub-domain
│ ├── packages/
│ │ ├── preset/ # Custom Docusaurus preset and plugins
│ │ └── theme/ # Swizzled React theme components and overrides
│ └── services/
│ └── portal/ # The main Docusaurus service application
│ ├── src/ # Custom React layout components and assets
│ ├── docusaurus.config.ts # Master Docusaurus site configuration
│ └── sidebars.ts # Main documentation sidebar rules
└── crowdin.yml # Translation synchronization configuration

Internacionalização (i18n) e GitOps​

O tupynambalucas.dev Docs oferece suporte completo aos locales de inglês (en) e português (pt-BR) usando um Unidirectional GitOps Flow estrito gerenciado pelo Crowdin.

  • Source of Truth (English): O repositório do GitHub armazena apenas os documentos de origem em inglês dentro do diretório collections/.
  • Translation Engine (pt-BR): A plataforma Crowdin atua como o principal mecanismo de tradução. Ela gera continuamente artefatos traduzidos e os envia para o repositório por meio de Pull Requests automatizados direcionados ao diretório locales/.
  • Build Isolation: Durante o build pipeline, um plugin personalizado sincroniza dinamicamente o conteúdo de locales/ diretamente no diretório do mecanismo i18n/ do Docusaurus. O diretório i18n/ é intencionalmente ignorado pelo Git (.gitignore) para isolar o mecanismo de renderização das coleções de conteúdo.

Scripts do Workspace​

Execute estes comandos a partir do diretório raiz para gerenciar o contexto da documentação:

ComandoAção
pnpm infra:devInicia todo o cluster do Skaffold, incluindo o portal do Docusaurus na porta 3002.
pnpm kb:docusaurus:portal:devInicia o servidor de desenvolvimento local do Docusaurus de forma independente em http://localhost:3002.
pnpm kb:docusaurus:portal:buildCompila o build de produção do portal Docusaurus e executa a validação de links.