Skip to content

docs(AGENTS): add Layout conventions section #9

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 #9

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
20 changes: 20 additions & 0 deletions AGENTS.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -164,3 +164,23 @@ still match what the pipeline produces.
- **No live network at pipeline run time.** `make sources` is the only
stage that touches the network; all downstream stages read disk.
- **Determinism.** Reconcile output must be byte-stable across runs.

## Layout conventions

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

| Path | Contents |
|---|---|
| `docs/` | Spec, ADRs, user guides, build logs, m-libraries surveys |
| `integrated/` | Reconciled cross-source layer — machine-readable M-language reference (TSV + JSON) |
| `per-source/` | Per-source extracted TSVs (anno / ydb / iris) — provenance layer |
| `schemas/` | JSON Schemas validating `integrated/*.json` |
| `sources/` | Offline replicas of upstream sources |
| `mappings/` | Hand-maintained cross-source name mappings |
| `dist/` | Phase 0 `repo.meta.json` (org-level contract) |
| `src/m_standard/` | Library + pipeline tools |
| `tools/` | Non-Python helpers (`clone-ydb.sh`, `check-repo-meta.py`) |

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