Skip to content

Welcome to Internal Docs

Centralized documentation for all BVR ST CO projects, services, and standards.

Category Description
Services Documentation for all microservices and applications
Guides Cross-team standards, onboarding, and architecture
Legacy Imported documentation from previous systems

How This Works

flowchart LR
    A[Service Repo] -->|Merge to main| B[GitHub Action]
    B -->|Syncs /docs| C[internal-docs]
    C -->|Build & Deploy| D[Dokploy]
    D --> E[internal.bvrstco.com]

Each service repository automatically pushes its /docs folder to this hub when changes are merged to main. Only changes to /docs trigger the sync—code-only commits are ignored.

The hub rebuilds and deploys automatically within minutes.

Adding Your Service's Docs

Want to add documentation for your service? See the Contributing Guide for step-by-step instructions.

TL;DR:

  1. Add a /docs folder with an index.md to your repo
  2. Copy the push workflow to .github/workflows/push-docs.yml
  3. Ask a maintainer to add your service to the navigation