Skip to content

Documentation Deployment Flow

To ensure the THAP Engine documentation is always accessible to the global community, we use GitHub Actions to automate the deployment process.

🔄 Automated Workflow (CI/CD)

The deployment follow this flow:

  1. Push to Master: Every time code or documentation is pushed to the master or main branch.
  2. GitHub Action Trigger: The .github/workflows/gh-pages.yml workflow starts.
  3. Environment Setup: A virtual machine starts, installs Python and the mkdocs-material theme.
  4. Build & Deploy: MkDocs builds the static site and pushes it to the gh-pages branch.
  5. Live Site: The documentation is updated automatically at https://<your-username>.github.io/micro-ai-robot-thap-firmware/.

🛠️ Manual Activation

If this is a new repository, you must enable GitHub Pages:

  1. Go to your GitHub repository Settings.
  2. Select Pages from the sidebar.
  3. Under Build and deployment > Source, select Deploy from a branch.
  4. Under Branch, select gh-pages and folder / (root).
  5. Click Save.

[!NOTE] The documentation is bilingual. Visitors can choose their language directly from the navigation menu or the landing page.