|
| 1 | +# LoopForge (meos) Agent Notes |
| 2 | + |
| 3 | +These instructions apply to the `meos/` repository. |
| 4 | + |
| 5 | +## Public vs internal docs boundary |
| 6 | + |
| 7 | +- **Public docs** are built only from `docs-site/` (see `mkdocs.yml` `docs_dir: docs-site`). |
| 8 | +- Keep maintainer maps, strategy notes, and competitor references **out** of `docs-site/`. |
| 9 | +- Internal references live under: |
| 10 | + - `docs/internal/` (start here: `docs/internal/index.md`) |
| 11 | + - `docs/plans/` |
| 12 | + - `docs/internal/competitive/` |
| 13 | + |
| 14 | +## Plans and writeups |
| 15 | + |
| 16 | +- Design / decision writeups: `docs/plans/YYYY-MM-DD-<topic>-design.md` |
| 17 | +- Implementation plans: `docs/plans/YYYY-MM-DD-<topic>.md` |
| 18 | +- Prefer small, focused commits; keep behavior changes separate from refactors/docs when possible. |
| 19 | + |
| 20 | +## Verification (evidence before claims) |
| 21 | + |
| 22 | +Before claiming something “works”, “passes”, “is done”, or before pushing a release tag, run fresh verification: |
| 23 | + |
| 24 | +- `make check` |
| 25 | + |
| 26 | +If you can’t use `make`, run the underlying commands: |
| 27 | + |
| 28 | +- `cargo fmt --all --check` |
| 29 | +- `cargo test --workspace --locked` |
| 30 | +- `python3 -m mkdocs build --strict` (when docs change) |
| 31 | + |
| 32 | +## Versioning + changelog rule |
| 33 | + |
| 34 | +If an iteration is marked “needs version bump”, the same change set must include: |
| 35 | + |
| 36 | +- `Cargo.toml` `[workspace.package].version` |
| 37 | +- matching section in `CHANGELOG.md` |
| 38 | + |
| 39 | +The PR/commit is not releasable if only one of them changes. |
| 40 | + |
| 41 | +## Docs toolchain |
| 42 | + |
| 43 | +Docs deps are pinned in `requirements-docs.txt`. Recommended local setup: |
| 44 | + |
| 45 | +- `make docs-venv` (creates `.venv-docs/` and installs deps) |
| 46 | +- `make docs` |
| 47 | + |
| 48 | +## Release preflight (maintainers) |
| 49 | + |
| 50 | +- `loopforge release check --tag vX.Y.Z` |
| 51 | +- Avoid publishing competitor content: release check treats this as a blocker. |
0 commit comments