The Magogi Foundation engineering-standards corpus, federation contract, and library registry — the source of truth for the mgf-* federation
Project description
mgf-doc-standard
The Magogi Foundation's engineering-standards corpus, federation contract, and library registry — the single source of truth for the
mgf-*federation.Conformance: L2 per its own
docs/standards/(one documented CFM-04 carve-out — seedocs/inprogress/MGF_STANDARDS_CONFORMANCE.md). Audience: every Magogi project (humans + AI agents). If you depend onmgf-commonor anymgf-*sibling, the rules you follow live here.
What this repo is
mgf-doc-standard is the standards leaf of the Magogi Foundation. It
carries, as the canonical version-controlled source of truth:
- The engineering-standards corpus (
docs/standards/) — the AP / CF / EH / LG / SC / TS / DP / DOC / … rule families every federation project conforms to, with a master index + per-topic Rules boxes. - The federation contract (
FEDERATION.md) — what you owe by depending on the federation, and what it gives you. Every other repo (including themgf-commoncornerstone) ships a pointer stub to this copy (DOC-17). - The library registry (
MGF_LIBRARIES.md) — the always-current map of every federation library, kept honest by the REL-13 consistency gate (scripts/gen_mgf_libraries.py). - Foundation-level design + process docs — the federation-pattern
architecture paper (
docs/design/federation.md) and the federation-operations recipes (docs/recipes/: cohort releases, sibling renames, the sync prompt, and the pointer-stub / adoption / conformance templates).
Why it's a separate repo (and a tiny package)
The standards used to live inside mgf-common. They were extracted so the
rules version independently of the implementation: mgf-common is the
reference implementation + the CLI front door; mgf-doc-standard is the
specification. mgf-common now depends on mgf-doc-standard.
The repo ships a tiny, zero-dependency data package, mgf.doc_standard,
that carries the corpus as wheel data and exposes a typed resolver:
import mgf.doc_standard as std
std.standards_dir() # Path to the corpus directory
std.list_standards() # ['API_DESIGN', 'CONFIGURATION', 'LOGGING', ...]
std.read_standard("LOGGING") # the full LOGGING.md text
std.recipes_dir() # Path to the federation-operations recipes
std.list_recipes() # ['cohort-release-wave', 'federation-sync-prompt', ...]
std.read_recipe("federation-sync-prompt") # the /sync prompt text
std.libraries() # the federation registry (roster + dep graph)
It depends on nothing in the mgf.* namespace — it is the federation
leaf-of-leaves, sitting below mgf-common in the dependency graph
(mgf-doc-standard ← mgf-common ← every sibling ← every consumer), so
the runtime graph stays acyclic.
How to read the standards
You almost never read this repo directly — you read it through
mgf-common's CLI, which is installed in every federation project:
mgf-common standards # list all topics
mgf-common standards LOGGING # print one
mgf-common agents # the canonical AI-agent briefing
Those commands resolve this package's corpus via
mgf.doc_standard.standards_dir(). Reading the rules never requires a
checkout of this repo.
Repo layout
| Path | What |
|---|---|
FEDERATION.md |
The federation contract (canonical; others link here) |
MGF_LIBRARIES.md |
The library registry (generated; REL-13 gate) |
docs/standards/ |
The engineering-standards corpus (the rules) |
docs/design/federation.md |
The federation-pattern architecture paper |
docs/recipes/ |
Federation-operations recipes + templates |
scripts/gen_mgf_libraries.py |
Registry generator + consistency gate |
src/mgf/doc_standard/ |
The tiny resolver package (corpus shipped as data) |
Federation links
- Cornerstone / CLI:
mgf-common - Contract:
FEDERATION.md· Registry:MGF_LIBRARIES.md - Feedback (standards proposals + cross-cutting rules):
FEEDBACK.md - Onboarding:
STARTHERE.md· Contributing:CONTRIBUTING.md
License
MIT — see LICENSE.
Project details
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file mgf_doc_standard-0.1.4.tar.gz.
File metadata
- Download URL: mgf_doc_standard-0.1.4.tar.gz
- Upload date:
- Size: 520.4 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/6.2.0 CPython/3.11.15
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
4b4515b894a00218abb82375e693dff0e56e55bd6c85e7143f3e4176cc655a7c
|
|
| MD5 |
9e659014e8202a5ea2855923106e501a
|
|
| BLAKE2b-256 |
b23ea8335d2bdd627098fc5d0c0b1b83bec02a73c140c78faf5cdc56d14bcdbf
|
File details
Details for the file mgf_doc_standard-0.1.4-py3-none-any.whl.
File metadata
- Download URL: mgf_doc_standard-0.1.4-py3-none-any.whl
- Upload date:
- Size: 444.3 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/6.2.0 CPython/3.11.15
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
2c3e43eba3cfc94b25baed328f6d1c64c2ee6301dba799eb244f34c77ed078ad
|
|
| MD5 |
6a6f019edd5feaec3b0c248c3a0fe1f5
|
|
| BLAKE2b-256 |
c06ebb4d361eb79691aebbcf135aadba68b039badc896e2e48e7f081e7861bed
|