---
type: guide
title: Guide name
status: active # draft | active | deprecated
created: 2026-06-26
updated: 2026-06-26
tags: []
audience: dev # dev | agent | both — who this guide is written for
related: [] # paths to related docs
---

# Guide name

## Purpose

What this guide helps a developer of this repo (or an agent working in it) do, in one or two sentences.

## Background

Any context needed to follow the guide — what the library/tool/spec is, why we use it, links to official docs (the [OKF spec](https://github.com/GoogleCloudPlatform/knowledge-catalog/tree/main/okf), the [`okf` crate](https://crates.io/crates/okf), etc.).

## The guide

The actual content: how-to steps, conventions, API patterns, gotchas. Prefer concrete examples (real commands, real Rust snippets) over abstract description.

```sh
# real, runnable examples beat prose
```

## Gotchas

Surprising behaviors, sharp edges, things that cost someone an afternoon (mise-shim PATH issues, frontmatter quoting, OKF-vs-repo conformance gaps). This section is often the most valuable part — keep it updated.

## References

- Official docs, source links, related guides and ADRs.
