This folder contains the blueprint registry and dashboard for the OPI Project.
| File | Purpose |
|---|---|
blueprints.yaml |
The source of truth. Edit this to add or update blueprints. |
index.html |
GitHub Pages dashboard — reads blueprints.yaml live in the browser. |
BLUEPRINTS.md |
Auto-generated Markdown summary (updated by GitHub Actions on every push). |
.github/workflows/update-blueprints.yml |
Workflow that regenerates BLUEPRINTS.md when blueprints.yaml changes. |
.github/scripts/generate_blueprints_md.py |
Python script used by the workflow. |
- Open
blueprints.yaml - Copy an existing entry as a template
- Fill in your blueprint's details (use the next
BP-NNNID) - Set
stage: proposed - Open a PR — the dashboard will update automatically when merged
proposed → tsc_review → build → validate → published
- Go to Settings → Pages in the
opiproject/opirepo - Set source to Deploy from a branch
- Select branch
main, folder/blueprints - The dashboard will be live at
https://opiproject.github.io/opi/blueprints/