ABOUT.pl.md ships as the Polish scaffold next to ABOUT.md, like the other .pl.md docs. Agents read both when both are filled in; ABOUT.md wins on a conflict (AGENTS.md, ckb-ingest). ckb-init copies both and puts a Polish answer in the Polish file; ckb-upgrade creates it once for KBs below 1.26.2; ckb-reset leaves it alone; the mcp server's kb_overview includes it and its description ignores either placeholder. READMEs, QUICKSTART.pl, both manuals and both changelogs updated. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
68 lines
2 KiB
Markdown
68 lines
2 KiB
Markdown
---
|
|
type: about
|
|
tldr: One sentence on what this knowledge base holds and who it is for.
|
|
last_updated: 2026-10-31
|
|
---
|
|
|
|
# About this knowledge base
|
|
|
|
<!--
|
|
This file is yours. It says what this KB is *for*: purpose, audience,
|
|
scope, owners, sensitivity. It says nothing about how the Cascade KB works;
|
|
that is README.md, docs/ and AGENTS.md.
|
|
|
|
ABOUT.pl.md is the same file in Polish. Fill in the one that matches your
|
|
KB's language and delete the other if you like. If both are filled in, the
|
|
agent reads both, and ABOUT.md wins where they differ.
|
|
|
|
Agents read this file and never edit it unless you ask. Ingest checks new
|
|
material against "Scope" and "Sensitivity"; the MCP server shows it to
|
|
remote clients; wiki/overview.md summarises what the KB actually holds and
|
|
links back here.
|
|
|
|
Replace each comment with your own text, or delete a section that does not
|
|
apply. Keep it to a page. Update `tldr` (one sentence: it names the KB to
|
|
MCP clients) and `last_updated` when you change it.
|
|
-->
|
|
|
|
## Purpose
|
|
|
|
<!-- What this KB is for, in two or three sentences. Which questions should
|
|
it be able to answer? -->
|
|
|
|
## Audience
|
|
|
|
<!-- Who reads it or asks it questions: a team, a client, newcomers, only
|
|
you. What do they already know? -->
|
|
|
|
## Scope
|
|
|
|
**In scope:**
|
|
|
|
<!-- Topics, projects, systems, time period this KB covers. -->
|
|
|
|
**Out of scope:**
|
|
|
|
<!-- What does not belong here, even if someone drops it in the inbox, and
|
|
where it goes instead if anywhere. -->
|
|
|
|
## Owners and contacts
|
|
|
|
<!-- Who curates this KB, who decides what goes in, and who to ask about
|
|
each area. Names or roles. -->
|
|
|
|
## Expected sources
|
|
|
|
<!-- Where knowledge should come from: meeting notes, a SharePoint site,
|
|
specs, interviews. wiki/overview.md lists what has actually been ingested. -->
|
|
|
|
## Sensitivity
|
|
|
|
<!-- Confidentiality level and handling rules: what must never be stored
|
|
here (credentials, personal data, client names outside their project),
|
|
and who may see the KB. -->
|
|
|
|
## Language and terms
|
|
|
|
<!-- The language wiki pages are written in, and any terms or abbreviations
|
|
a reader must know. -->
|