Lumi/knowledge/README.md
2026-06-25 14:10:04 +02:00

54 lines
1.8 KiB
Markdown

# Lumi OKF Knowledge Files
This directory holds file-backed OKF Markdown sources.
- `core/`: generated or maintained Lumi core behavior knowledge.
- `plugins/`: generated or maintained plugin behavior knowledge.
- `community/`: admin-maintained community facts, terminology, names, rules, links, and local context.
- `corrections/`: admin-reviewed corrections created from feedback or AI review flows.
Files use Markdown with optional frontmatter:
```md
---
id: community.currency
title: Community currency
scope: community
status: active
priority: 50
visibility: user
tags: currency, economy
generated: false
editable: true
created_at: 2026-06-19T00:00:00.000Z
updated_at: 2026-06-19T00:00:00.000Z
---
# Community currency
The community currency is coins.
```
`status` should be `active` or `published` for retrieval. `visibility` may be `user`, `mod`, or `admin`.
Corrections have the highest retrieval priority, followed by community, plugin, and core knowledge.
## Placeholders
Markdown bodies may reference visible frontmatter values with `{{entry.id.field_name}}`.
For example, a file with `id: community.currency` and `primary_name: coins` can be referenced as:
```md
The currency is {{community.currency.primary_name}}.
```
Placeholders are resolved only from knowledge entries visible to the current user. Missing or hidden references become a short missing-reference marker instead of crashing retrieval.
## Update Preservation
Repo-based and ZIP fallback updates preserve the local OKF authoring paths:
- `knowledge/community`
- `knowledge/corrections`
Generated `knowledge/core` and `knowledge/plugins` files are reproducible from the current codebase and plugin manifests. Do not place local-only edits in generated files unless they are explicitly marked `generated: false` or `editable: true`.