Skip to content

Commit 3a75547

Browse files
committed
docs: add agent guardrails and make check
1 parent 351e839 commit 3a75547

2 files changed

Lines changed: 83 additions & 0 deletions

File tree

AGENTS.md

Lines changed: 51 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,51 @@
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.

Makefile

Lines changed: 32 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,32 @@
1+
.PHONY: help fmt fmt-check test docs docs-venv check
2+
3+
help:
4+
@echo "LoopForge (meos) common targets:"
5+
@echo " make fmt - cargo fmt"
6+
@echo " make fmt-check - cargo fmt --check"
7+
@echo " make test - cargo test (workspace, locked)"
8+
@echo " make docs - mkdocs build --strict (uses .venv-docs if present)"
9+
@echo " make docs-venv - create .venv-docs and install docs deps"
10+
@echo " make check - fmt-check + test + docs"
11+
12+
fmt:
13+
cargo fmt --all
14+
15+
fmt-check:
16+
cargo fmt --all --check
17+
18+
test:
19+
cargo test --workspace --locked
20+
21+
docs:
22+
@if [ -x .venv-docs/bin/python ]; then \
23+
.venv-docs/bin/python -m mkdocs build --strict; \
24+
else \
25+
python3 -m mkdocs build --strict; \
26+
fi
27+
28+
docs-venv:
29+
python3 -m venv .venv-docs
30+
.venv-docs/bin/pip install -r requirements-docs.txt
31+
32+
check: fmt-check test docs

0 commit comments

Comments
 (0)