Skip to content

docs(AGENTS): add Layout conventions section#6

Merged
rafael5 merged 1 commit into
mainfrom
docs/layout-conventions
May 11, 2026
Merged

docs(AGENTS): add Layout conventions section#6
rafael5 merged 1 commit into
mainfrom
docs/layout-conventions

Conversation

@rafael5
Copy link
Copy Markdown
Collaborator

@rafael5 rafael5 commented May 11, 2026

Summary

Specializes the org-level layout rule for m-stdlib's top-level layout. States the cross-repo rule (`docs/` is prose-only) and maps each top-level dir to its purpose: `docs/` for tracking + per-module reference + plans + guides + testing writeups, `dist/` for Phase 0 contract + generated artifacts (manifest / errors / skill), `examples/` for demo M source, `templates/` for project scaffolds, `scripts/` for shell helpers, `src/` for M source, `tests/` for hand-written + generated test suites, `tools/` for Python generator scripts.

Inserted after Guardrails — both are "rules of the road" sections.

Links back to `.github/CONTRIBUTING.md` § Layout conventions (landed in .github PR #4).

Pure documentation — no behavioural change.

Specializes the org-level layout rule for m-stdlib's top-level
layout. States the cross-repo rule (docs/ is prose-only) and maps
each top-level dir to its purpose: docs/ for tracking + per-module
reference + plans + guides + testing writeups, dist/ for Phase 0
contract + generated artifacts (manifest / errors / skill), examples/
for demo M source, templates/ for project scaffolds, scripts/ for
shell helpers, src/ for M source, tests/ for hand-written +
generated test suites, tools/ for Python generator scripts.

Links back to .github/CONTRIBUTING.md § Layout conventions for the
org-level rule.
@rafael5 rafael5 merged commit f59b08b into main May 11, 2026
2 checks passed
@rafael5 rafael5 deleted the docs/layout-conventions branch May 11, 2026 00:36
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant