Repo Setup

This page covers how the cargo-docs submodule stays in sync with the parent cargo repo. To run the api, app, and backoffice locally, see Local Setup.

cargo-docs is included in the parent cargo repo as a git submodule, checked out at the repo root (cargo-docs/). A shared git hooks directory keeps it in sync automatically.

One-Time Setup

Teammates who clone the parent cargo repo need to run this once:

git config core.hooksPath .githooks

This points git at the repo's shared hooks (.githooks/), which auto-sync the cargo-docs submodule to the latest commit on post-merge and post-checkout.