README

AiCE-Lab documentation catalogue

Publishes https://aice-lab.gitlab.io/docs/ — an index of every AiCE-Lab tool, and each tool’s handbook at /docs/<product>/.

Adding a product

Add an entry to products.yml. Nothing else.

- slug: envkit
  name: envkit
  tagline: Your dotfiles in git, your secrets in the OS keychain.
  language: Go
  licence: MIT
  repo: https://gitlab.com/aice-lab/envkit
  clone: https://gitlab.com/aice-lab/envkit.git
  book: true          # false -> listed in the index, linked to its README

book: true means the repository has a book.toml and a docs/ directory. CI clones it and builds it with mdbook; the build fails loudly if the book.toml is missing, rather than publishing an empty directory.

Why the handbooks live in the product repos

Documentation edited beside its code stays true. Moving the sources here would let them drift a release behind, and would break each book’s “edit this page” link. So this repo holds the index and the build, and owns no prose but its own.

No credentials

Every product repo is public, so CI clones them anonymously. There is no deploy key or token here to rotate or leak.

Rebuilding when a product changes

The product’s own pipeline triggers this one. Until that is wired for a given product, a push here or a scheduled run picks up its latest docs.

This is a snapshot generated from GitLab. For the live README, see the project page.