52 lines
1.8 KiB
Markdown
52 lines
1.8 KiB
Markdown
# ourdigital-okf
|
|
|
|
A custom OurDigital Claude skill for **Google Open Knowledge Format (OKF) v0.1** — produce,
|
|
validate, and visualize knowledge bundles (directories of markdown concept files with YAML
|
|
frontmatter).
|
|
|
|
## Modes
|
|
|
|
| Mode | What it does |
|
|
|------|--------------|
|
|
| **produce** | Claude drafts a conformant OKF bundle from a pasted/exported schema, a docs folder, or a `/reference-curator` research topic. |
|
|
| **validate** | Lints a bundle for OKF v0.1 conformance (parseable frontmatter + non-empty `type`); reports broken cross-links as warnings. |
|
|
| **visualize** | Renders a bundle as a self-contained interactive Cytoscape graph (`viz.html`). |
|
|
|
|
## Install
|
|
|
|
```bash
|
|
./install.sh
|
|
```
|
|
|
|
Symlinks the skill into `~/.claude/skills/ourdigital-okf`. Invoke with `/ourdigital-okf`.
|
|
|
|
## Scripts (Python standard library only — no pip install)
|
|
|
|
```bash
|
|
python3 code/scripts/okf_validate.py <bundle> [--json]
|
|
python3 code/scripts/okf_viz.py --bundle <bundle> [--out viz.html] [--name "Name"]
|
|
```
|
|
|
|
Run the tests from `code/scripts/`:
|
|
|
|
```bash
|
|
python3 -m unittest discover -s tests
|
|
```
|
|
|
|
The suite is verified against Google's three reference bundles mirrored at
|
|
`~/Documents/reference-library/open-knowledge-format/okf/bundles/` (crypto_bitcoin, ga4,
|
|
stackoverflow).
|
|
|
|
## Layout
|
|
|
|
- `SKILL.md` — canonical entry; `code/SKILL.md` — detailed Claude Code flows; `desktop/` — Claude Desktop variant.
|
|
- `code/references/` — distilled OKF spec + frontmatter reference.
|
|
- `code/assets/` — concept/index/log templates.
|
|
- `code/scripts/` — `okf_common.py`, `okf_validate.py`, `okf_viz.py` + tests.
|
|
- `DESIGN.md` — approved design spec. `docs/IMPLEMENTATION-PLAN.md` — build plan.
|
|
|
|
## Reference
|
|
|
|
OKF spec and reference implementation:
|
|
<https://github.com/GoogleCloudPlatform/knowledge-catalog/tree/main/okf>
|