# AGENTS.md

Easy to maintain open source documentation websites.

## Setup

```
pnpm install
```

## Commands

```
pnpm start                   # run the app
pnpm build                   # produce a build
pnpm test                    # run the test suite, must pass before any commit
pnpm lint                    # lint
pnpm format                  # format
pnpm start:website
pnpm start:website:profile
pnpm start:website:baseUrl
```

## Layout

- `packages/`  1018 source files
- `website/`   106 source files
- `admin/`     11 source files
- `examples/`  8 source files
- `test/`      5 source files
- `__tests__/` 2 source files

## Conventions

- Tests live alongside the code they cover, following `.github/workflows/showcase-test.yml`.
- CI defines what passing means. See `.github/workflows/argos.yml`, and keep it green.
- TODO: add the two or three conventions a newcomer always gets wrong here.

---

Drafted by agentreadme.com from what is in this repository. Everything marked TODO
needs a human. Check it in as AGENTS.md at the root.