diff --git a/README.md b/README.md new file mode 100644 index 0000000..0ba0ceb --- /dev/null +++ b/README.md @@ -0,0 +1,39 @@ +# Inference Cooperative — operator documentation + +Operator- and maintainer-facing documentation for the Inference Cooperative. +This is the material that describes how the co-op's infrastructure is run — +access tokens, scheduled tasks, maintenance procedures, and outage write-ups — +as opposed to the member-facing documentation published at +. + +## This repository is deliberately not a website + +Unlike `co-op/docs`, **nothing here is built or published by MkDocs**. The +repository is *git-only*: it is meant to be browsed, searched, and diffed in +Gitea, or read from a clone. Every page carries operational detail (token +rotation, deploy flows, failure modes) that belongs to operators rather than to +members, so it is kept out of the public documentation site on purpose. + +Read it on the web here: + +## What is here + +| Path | Contents | +|---|---| +| `operator-token-runbook.md` | The Cloudron token model (agent vs portal, admin vs webhook), how to rotate each without breaking the stack | +| `maintenance/chat-task-models.md` | The small pinned model used for chat titles/tags/suggestions | +| `maintenance/librechat-sandbox.md` | Operating the LibreChat evaluation instance (config, overlay image, key sync, pitfalls) | +| `incidents/` | Post-incident write-ups, one file per incident | + +## Where operators look + +- **Member-facing docs** live in [`co-op/docs`](https://git.inference.coop/co-op/docs) + and are published at . +- **Migration runbooks** live in [`co-op/runbooks`](https://git.inference.coop/co-op/runbooks). +- The member-facing docs link here from their "For operators" section. + +## History + +These files were moved here from `co-op/docs`, where they were previously +published on the member-facing site. The commit history for each file is +preserved in this repository.