1. Preface
  2. Table of Contents
  3. Part 1 — Meet OKF
  4. 1. What is OKF
  5. 2. Why OKF (vs. RAG)
  6. 3. History of Knowledge Bases
  7. 4. Core concepts you should know
  8. Part 2 — Getting Started
  9. 5. Install
  10. 6. Your first knowledge base
  11. 7. Project layout
  12. Part 3 — Core Concepts
  13. 8. Bundle, Concept, and Concept ID
  14. 9. Frontmatter (metadata)
  15. 10. Linking into a knowledge graph
  16. 11. Reserved files: index.md and log.md
  17. Part 4 — Everyday Operations
  18. 12. Ingest: adding knowledge to the wiki
  19. 13. Query and Search
  20. 14. Adding and editing concepts
  21. 15. Validate and Visualize
  22. 16. Worked example: a bookstore KB
  23. Part 5 — Authoring Well
  24. 17. Best practices and anti-patterns
  25. Part 6 — Enterprise
  26. 18. Architecture overview
  27. 19. Self-hosted deployment
  28. 20. Write models: PR-gated and Lease
  29. 21. Search at scale and semantic
  30. 22. Security and governance
  31. Appendix
  32. 23. Tools reference (CLI)
  33. 24. FAQ
  34. 25. Glossary
  35. 26. References

The Open Knowledge Format (OKF) Handbook

Table of Contents

Part 1 — Meet OKF

  • What is OKF
  • Why OKF (vs. RAG)
  • History of Knowledge Bases
  • Core concepts you should know

Part 2 — Getting Started

  • Install
  • Your first knowledge base
  • Project layout

Part 3 — Core Concepts

  • Bundle, Concept, and Concept ID
  • Frontmatter (metadata)
  • Linking into a knowledge graph
  • Reserved files: index.md and log.md

Part 4 — Everyday Operations

  • Ingest: adding knowledge to the wiki
  • Query and Search
  • Adding and editing concepts
  • Validate and Visualize
  • Worked example: a bookstore KB

Part 5 — Authoring Well

  • Best practices and anti-patterns

Part 6 — Enterprise

  • Architecture overview
  • Self-hosted deployment
  • Write models: PR-gated and Lease
  • Search at scale and semantic
  • Security and governance

Appendix

  • Tools reference (CLI)
  • FAQ
  • Glossary
  • References