This repository provides public Mermaid graph standards, class definitions, templates, examples, rendering checks, and boundary rules for 218 Network Foundation repositories.
The graph kit is documentation infrastructure. It does not contain private topology, security-sensitive infrastructure detail, sealed process diagrams, donor data, student data, school private data, private telemetry, model-development internals, or real operational maps.
| Field | Value |
|---|---|
| Status | published / scaffolded |
| Entity owner | 218 Network Foundation |
| Authority | Foundation graph standard authority aligned to repo-blueprint |
| Canonical source | GitHub public graph standards source |
| GitHub role | Public Mermaid classes, templates, examples, and rendering checks |
| Hugging Face role | Optional diagram companion references for future cards and Spaces |
| Public surface | Public graph standards and reusable diagram patterns |
| Repository | Relationship |
|---|---|
foundation-doc-templates |
Documentation template source that references graph templates. |
foundation-governance |
Governance authority and publication boundary examples. |
foundation-transparency-reports |
Transparency workflow and reporting map examples. |
civic-ai-safety-notes |
Safety and public reliance map examples. |
foundation-model-cards |
Model release flow and sealed boundary examples. |
foundation-dataset-cards |
Dataset release and data boundary map examples. |
| Path | Role |
|---|---|
classes.md |
Reusable Mermaid class definitions and color roles. |
templates/graph.md |
Standard graph file template. |
templates/class-definitions.md |
Copyable class definition block. |
examples/README.md |
Public-safe example index. |
examples/authority-boundary-map.md |
Generic authority and boundary map example. |
examples/release-workflow-map.md |
Generic release workflow example. |
docs/graph-standard.md |
Graph authoring rules. |
docs/rendering-checklist.md |
GitHub render and readability checks. |
docs/public-private-diagram-boundary.md |
Rules for public-safe diagrams. |
docs/versioning-policy.md |
Graph kit version and change policy. |
docs/quality-gate.md |
Required checks before graph changes are published. |
docs/graphs/ |
Graph taxonomy and public/private diagram maps. |
Every public graph file should include:
- Purpose
- Mermaid diagram
- Interpretation notes
- Boundary notes
- Follow-up actions
Allowed:
- public graph templates;
- public class definitions;
- placeholder diagrams;
- generic authority, workflow, release, and boundary examples;
- public-safe diagrams from approved repositories.
Forbidden:
- private topology;
- exact sensitive infrastructure locations;
- security-sensitive NEURONA operational details;
- sealed YOSO-YAi LLC IP;
- sealed process diagrams;
- private model-development workflows;
- private datasets or telemetry flows;
- donor private data;
- student data;
- school private data;
- volunteer private data;
- customer data;
- secrets, tokens, and API keys;
- diagrams that expose private operations or reconstruct protected capability.
Run:
scripts/validate-graph-kit.shGraph kit v0.1 is complete when class definitions, graph template, public-safe examples, graph standard, rendering checklist, boundary rules, quality gate, and taxonomy maps are reviewed by human Foundation authority.
| Public Surface | Status | Meaning |
|---|---|---|
| Repository visibility | published |
Public GitHub repository intended for review. |
| Repository contents | scaffolded |
Standards, templates, graphs, and synthetic examples only. |
| Real operational data | planned |
No real operational data is published by this repository. |
| Released artifacts or live deployments | planned |
No released or live operational claim is made by this repository. |
| Private Foundation operations and sensitive records | private/not-public |
Excluded from the public repo. |