| okf_version | 0.2 |
|---|
Authored knowledge for this repository — architecture patterns, decision
records, operational playbooks, and a catalog of every module, package, host,
and Neovim plugin — structured as an
Open Knowledge Format
v0.1 bundle. Conventions and tooling are documented in the
OKF Profile. This bundle is the authored-rationale layer; it
complements AGENTS.md (agent working instructions) and the
derived .codebase-memory/ code graph.
- Task Manuals (docs/) - Entry point to the docs/ manuals layer — task-focused, machine-verified operational references with dated learnings, complementing knowledge/'s durable rationale and catalog.
- OKF Profile - This bundle's conventions on top of OKF v0.2 — required fields, link style, resource semantics, entry quality bar, type registry, and tooling.
- decisions - Decision records — why the repository is the way it is.
- hosts - The machines this flake configures, and which feature modules each enables.
- languages - The languages this repository is authored in — one doc per language covering how the repo uses it, the lint/format toolchain, and the editor wiring.
- modules - Catalog of darwin and NixOS feature modules, flake-parts plumbing modules, and nebula's host-specific files.
- nvim - The Neovim configuration — plugins, keymaps, LSP, and options for the Lua config tree under
home/nvim/. - packages - Custom packages, nixpkgs overlays, and the self-contained sub-flakes the root flake consumes via relative-path inputs.
- patterns - Named architectural patterns this repository is built on.
- playbooks - Operational how-tos for recurring tasks — rebuilds, adopting dotfiles, adding modules and packages, and keeping tooling up to date.
- runtimes - The runtimes this repo provisions and leans on — one doc each covering what it is, how it's wired here, and the contracts it imposes.