Skip to main content

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 — see docs/inprogress/MGF_STANDARDS_CONFORMANCE.md). Audience: every Magogi project (humans + AI agents). If you depend on mgf-common or any mgf-* 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 the mgf-common cornerstone) 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-standardmgf-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

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

mgf_doc_standard-0.1.3.tar.gz (460.7 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

mgf_doc_standard-0.1.3-py3-none-any.whl (426.3 kB view details)

Uploaded Python 3

File details

Details for the file mgf_doc_standard-0.1.3.tar.gz.

File metadata

  • Download URL: mgf_doc_standard-0.1.3.tar.gz
  • Upload date:
  • Size: 460.7 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.11.15

File hashes

Hashes for mgf_doc_standard-0.1.3.tar.gz
Algorithm Hash digest
SHA256 817e0fd5046b17eb654cc5e79a679798deb25631626287b02c7fe8e1505cb7db
MD5 55aaaa9cf054256def2648cbbd95d99f
BLAKE2b-256 c13a5583920c508c6c679eba20b2af80298d06e74095e16a604ed0973ab16c7b

See more details on using hashes here.

File details

Details for the file mgf_doc_standard-0.1.3-py3-none-any.whl.

File metadata

File hashes

Hashes for mgf_doc_standard-0.1.3-py3-none-any.whl
Algorithm Hash digest
SHA256 4bed0f9d27d1630e3fe6e0aba83f1e043ec357582dba5dfda20957841ae6be3c
MD5 b012417def8f8e9080cc7123c3264b37
BLAKE2b-256 e57e94f80dd57672de92d272f5dbb0470d60b7555970723210430cd0c5b09761

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page