Profile README vs Pages Site¶
ProtocolWarden exposes two different public-facing GitHub repositories:
| Repo | Purpose | Where it appears |
|---|---|---|
ProtocolWarden/ProtocolWarden |
GitHub profile README repository | github.com/ProtocolWarden profile front door |
ProtocolWarden/ProtocolWarden.github.io |
GitHub Pages documentation repository | protocolwarden.github.io public knowledge surface |
Why both exist¶
- The profile README is the short front door for first-time visitors.
- The Pages site is the full public architecture charter and documentation hub.
- The two surfaces should work together, not duplicate each other.
Rules¶
- The profile README stays brief.
- The Pages site carries the detailed architecture, repo catalog, ontology, topology, governance, and diagram content.
- Private-truth repositories are described only where the boundary must be explained, not as browseable public catalog entries.