Skip to main content

Knowledge Base (TupyDocs)

This section details the central developer portal onboarding references, guidelines, and translation parity tools.

Completed Milestones​

Documentation Engine & Layout​

  • Docusaurus Engine Integration: Configured Docusaurus v3 as our central developer portal (TupyDocs), providing a responsive documentation engine.
  • Custom MDX Component Pages: Programmed custom MDX pages (e.g. Tools Workspace ecosystem, Studio Branding) to visual-explain monorepo architecture workflows.
  • Left Navigation Sidebars: Implemented autogenerated context-based sidebars and structured paths for all sections, simplifying navigation structure.

Localization & Translation Parity​

  • Native Translation Pipelines: Integrated i18n support, creating a dual locale structure (English source and Portuguese pt-BR translation copies) with translation parity protocols.

CI/CD Deployment​

  • Automated Root Compilation (Paused): Built tasks to compile and push both CHANGELOG.md and ROADMAP.md to the repository root. This is temporarily disabled in the GitHub Actions workflow (deploy-docs.yaml) and will be refactored in a future phase.

Planned Focus​

  • Workflow & Compiler Refactor: Redesign and re-enable the modular document compiler (changelog and roadmap generation) inside the deploy pipeline with improved Git conflict resolution and isolated test suites.
  • Translation Verification Pipeline: Automate the verification check to ensure 100% documentation sync.
  • API Auto-Generation: Extract documentation blocks directly from Fastify routing controllers.