Skip to content

docs(AGENTS): add Layout conventions section #6

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
rafael5 merged 1 commit into from
May 11, 2026
Merged

docs(AGENTS): add Layout conventions section #6

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
19 changes: 19 additions & 0 deletions AGENTS.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -180,3 +180,22 @@ make check-manifest # drift gate: dist/ matches src/ AND repo.meta.json is co
module's source, tests, or per-module doc must update the relevant
row in `docs/tracking/module-tracker.md` (see "Tracking conventions"
above).

## Layout conventions

`docs/` holds **only** human-readable prose. Technical artifacts live
elsewhere — m-stdlib's top-level layout:

| Path | Contents |
|---|---|
| `docs/` | Tracking (changelog, module tracker, discoveries, parallel tracks), per-module API reference (`modules/`), plans, guides, testing writeups |
| `dist/` | Phase 0 `repo.meta.json` + `stdlib-manifest.json` / `errors.json` / `skill/` (drift gates) |
| `examples/` | Demo M source (e.g. `stdargs-demo.m`) |
| `templates/` | Project scaffolds (e.g. `m-vista-test-suite/`) |
| `scripts/` | Shell helpers |
| `src/` | M (`.m`) source |
| `tests/` | Test suites — hand-written `STD*TST.m` + generated `STD*DOCTST.m` |
| `tools/` | Python generator scripts (gen-manifest, gen-skill, gen-doctests, write-module-frontmatter) |

Enforced by `make check-docs-prose` (CI gate). Org-level rule:
[`.github/CONTRIBUTING.md` § Layout conventions](https://github.com/m-dev-tools/.github/blob/main/CONTRIBUTING.md#layout-conventions).
Loading