docs(AGENTS): add Layout conventions section - #6
Merged
rafael5 merged 1 commit intoMay 11, 2026
Merged
Conversation
Copy link
Copy Markdown
Collaborator
Sorry, something went wrong.
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.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
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.