Files
archie/docs/index.md
T
sam 9e6ac82cd4 docs(site): make docs/ buildable as a documentation site
Adds an mkdocs.yml, a landing page, and `task docs:site` / `task docs:serve`.
Deliberately hosting-agnostic: MkDocs is the same input Backstage TechDocs
consumes, so choosing where this lands later costs nothing.

exclude_docs holds back four subtrees, since everything under docs/ would
otherwise be published. archive/ is superseded design and would compete with
the current architecture for a reader's attention; inspiration/ discusses
other products by name; prds/ are open decisions rather than settled design;
github-token.md is credential setup. One PRD is let back through because
architecture/migration-decisions.md links to it three times, and a page
excluded out from under a live link is just a 404 with extra steps.

No nav block. MkDocs derives it from the directory layout, so a new page
under docs/architecture/ publishes without a second edit, and there is no
hand-maintained tree to drift against the repository.

Builds --strict, so a dead internal link fails rather than ships.
2026-09-18 13:16:09 +10:00

36 lines
1.5 KiB
Markdown

# Archie
Event Driven Agentic Automation.
**archied** is a resident daemon. It polls a forge (GitHub, Gitea) for issues
assigned or labelled to it, works each one in an isolated git worktree through a
routed workflow, and opens a pull request for human review.
It is not a chat wrapper around a repository. Work arrives as events, each task
runs in its own sandbox with its own credentials, and the model never runs git.
## Start here
- [First playbook](guides/first-playbook.md) walks through getting one piece of
work from an issue to a pull request.
- [Architecture](architecture/index.md) is the authority for settled design:
the package map, the workflow engine, the task lifecycle, and the invariants
that hold the whole thing together.
## What runs where
A deployment is one daemon plus the processes it talks to. The State Store is a
standalone process and owns the database outright; the daemon and gateway never
open it directly. Agents execute in containers that receive a task-scoped
credential, issued per task and revoked when the worktree is handed back.
Configuration lives at `${XDG_CONFIG_HOME:-~/.config}/archie/config.toml`.
Nothing in a working tree is load-bearing at runtime.
## A note on these docs
This site is generated from the `docs/` directory of the
[archie-core repository](https://github.com/samcharles93/archie-core) on every
change to `main`. The repository is the source; this site is a view of it. If
the two ever disagree, the repository is right.