Living docs
Documentation goes stale the moment you stop updating it. Living docs fixes that by letting your project write its own docs on a schedule. Turn it on once, and a small robot keeps the docs in step with the code from then on.
At a glance
Section titled “At a glance”| Question | Answer |
|---|---|
| Where does it run? | In your repository’s GitHub Actions |
| How often? | Once a day |
| What does it create? | An openwiki/ folder and an AGENTS.md pointer |
| What do you provide? | A GitHub token and one supported LLM key |
| Which builds support it? | Code builds, not media-only builds |
What it does
Section titled “What it does”Every finished build has a Living docs button. Click it, and LoopCodeLab adds a daily GitHub Action to that build’s repository. The Action runs a documentation agent that reads your code and writes a set of docs into the repo. Because it runs every day, the docs are regenerated as the code changes, so they stay current instead of drifting out of date.
You enable it once per build. Nothing changes in your other projects. The button appears on code builds such as web apps, not on media-only builds where a documentation folder would not be useful.
Where it runs
Section titled “Where it runs”The daily job runs on your own GitHub Actions, not on your machine and not on LoopCodeLab’s servers. When you click the button, LoopCodeLab scaffolds the workflow into your repo, kicks off the first run, and confirms it succeeded. After that, GitHub’s own schedule takes over and runs it once a day. There is no on-box generation: the work always happens in your GitHub Actions, off your machine.
It reuses your GitHub token to set this up and push the workflow. See GitHub token for connecting one and the scopes it needs.
What you need
Section titled “What you need”The documentation agent needs an LLM provider key to write with. It only works with providers that use a fixed base URL, so these are the supported ones:
- OpenAI
- OpenRouter
- Anthropic
- Baseten
- Fireworks
Connect any one of these in Settings and Living docs can use it. Your OpenAI and Anthropic keys are the same ones your build agents use, so if you have already connected either, you are ready. OpenRouter, Baseten, and Fireworks are extra options if you would rather point Living docs at one of them. See Coding agent keys for where these keys live in Settings and how to add them.
Your key is set as a secret on your GitHub repository so the daily Action can use it. It stays yours and is used only for this. Writing docs does not need a top-tier model, so a cheap, fast model is picked by default to keep the cost low.
If no supported key is connected, the button is disabled with a note telling you to connect an OpenAI or OpenRouter key first.
What you get
Section titled “What you get”An openwiki/ folder committed to your repository, holding docs written for anyone (or any agent) working on the project. It is committed straight to your main branch, and the daily run refreshes it whenever the code has changed. You will find it in your repo under openwiki/, and a pointer to it is added to your AGENTS.md file so tools and teammates know where to look.
From then on, the docs refresh in the background with at most one documentation commit a day, for as long as the Action remains enabled.