# STARTHERE — mgf-fedres

> **Sibling package in the Magogi Foundation federation.**
> See [README.md](README.md) for what it is; [FEDERATION.md](FEDERATION.md) for
> the federation contract.

`mgf-fedres` is the **federation-resources spine** — the headless core that both
`mgf-fed-web` (the federation dashboard) and `mgf-test-web` / ProofWarden (the
testing & CI authority console) build on. It owns the `fed-resources/` directory
convention, the single versioned schema set (`schema_version 0.1`), the version-
aware reader, the manifest + sync engine (`regenerate → byte-identical`), the
`SourceProvider` seam, the live NDJSON + run-record writers, and the `fedres` CLI.
No web framework — so the warden and CI can reuse the core without pulling FastAPI.

## For consumers

```bash
pip install mgf-fedres   # resolves from the self-hosted devpi index
```
```python
from mgf.fedres import read_file, validate_payload, SyncState

result = read_file("fed-resources/generated/status.json")
if result.ok:
    ...                       # result.payload is schema-valid
else:
    print(result.state)       # UNKNOWN (absent) / UNREADABLE (corrupt/unknown version)
```
Validate documents + live wire streams from the command line:

```bash
fedres-validate fed-resources/generated/*.json fed-resources/live/*.ndjson
```

## For contributors

See [CONTRIBUTING.md](CONTRIBUTING.md). Standards inherited from
[mgf-common](https://codeberg.org/magogi-admin/mgf-standard/src/branch/main/docs/standards/).

## Quick links

| Resource | Where |
|---|---|
| What it is + the layering | [README.md](README.md) |
| The end-to-end plan + specs | [docs/planning/](docs/planning/) |
| Scope policy | [SCOPE.md](SCOPE.md) |
| Deps / consumers | [DEPS.md](DEPS.md) |
| Conformance ledger | [docs/inprogress/MGF_STANDARDS_CONFORMANCE.md](docs/inprogress/MGF_STANDARDS_CONFORMANCE.md) |
| Federation contract | [FEDERATION.md](FEDERATION.md) |
