empty docs
Bundle OKF 0.2 · 6 conceitos · Danjohnsonnj/open-knowledge-format-support
Open source Repository Open in the app JSON README (API)
About
# empty docs
# Settled
* [Decisions](decisions.md) - locked rationale
* [Concepts](concepts/) - glossary, invariants, modules, architecture
* [Runbooks](runbooks/) - operational procedures
* [Agents](agents/) - agent guides and product state
# In progress
* [OKF skill distribution](plans/okf-skill-distribution/HANDOFF.md) - Version and install the okf-docs skill from this repository
* [OKF repo documentation](plans/okf-repo-docs/HANDOFF.md) - Make OKF-compatible, agent-maintained repo docs the default (v1 complete)
Details
- Kind
- OKF bundles
- Topic
- No topic detected
- Publisher
- danjohnsonnj
- Origin
- okf_github
- Category
- dados
- Version
- 0.2
- Last push
- 2026-08-30T14:55:12Z
- Repository state
- ativo
- Language
- Shell
- Added
- 2026-09-08 09:04:14
- Updated
- 2026-09-08 09:04:14
- Origin id
Danjohnsonnj/open-knowledge-format-support:docs/index.md
README
# open-knowledge-format-support Canonical source for the **okf-docs** agent skill and the OKF v0.2 software-repo documentation profile as a practical way to keep agent-readable repo docs versioned, loadable without MCP, and colocated with your code. ## What this is [Open Knowledge Format (OKF)](https://github.com/GoogleCloudPlatform/open-knowledge-format) defines a markdown + YAML frontmatter wiki pattern for LLM agents. This repository ships: - **`skills/okf-docs/`** — the `okf-docs` skill (init, maintain, and retrofit OKF-compatible `docs/` bundles) - **`docs/`** — a dogfood documentation bundle and design notes for the profile - **Installer scripts** — deploy the skill to Cursor or agent skill roots Code wins over wiki. The bundle (`docs/`) holds the knowledge; agents start at [`AGENTS.md`](AGENTS.md). ## Quick start Install the skill to your environment: ```sh ./scripts/install-okf-docs --target auto --mode copy ``` For local development against this repo, symlink instead: ```sh ./scripts/install-okf-docs --target both --mode link --replace ``` Verify the installer: ```sh ./scripts/smoke-install-okf-docs ``` See [SCRIPTS.md](SCRIPTS.md) for full options (`--target`, `--mode`, `--replace`). ## Install targets | Target | Path | | ------ | --------------------------- | | Cursor | `~/.cursor/skills/okf-docs` | | Agents | `~/.agents/skills/okf-docs` | Edit the skill in **`skills/okf-docs/`** in this repository — not in your home directory. Re-run the installer after changes (or use `link` mode). ## Documentation - [AGENTS.md](AGENTS.md) — agent entry (prefer over README for the narrow query path) - [docs/index.md](docs/index.md) — bundle hub (settled knowledge and in-progress efforts) - [skills/okf-docs/SKILL.md](skills/okf-docs/SKILL.md) — skill entry point - [skills/okf-docs/producer-profile.md](skills/okf-docs/producer-profile.md) — implementer spec for the software-repo profile ## Repository layout ``` skills/okf-docs/ Canonical okf-docs skill source docs/ OKF documentation bundle (concepts, runbooks, plans) scripts/ install-okf-docs, smoke-install-okf-docs SCRIPTS.md Command reference ```