Template 1.26.2: ABOUT.pl.md, the Polish pair of ABOUT.md
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>
This commit is contained in:
parent
cf9e08157b
commit
56c0511ac7
17 changed files with 110 additions and 20 deletions
|
|
@ -182,7 +182,7 @@ class KB:
|
|||
def overview(self):
|
||||
self.maybe_pull()
|
||||
parts = []
|
||||
for name in ("ABOUT.md", "wiki/index.md", "wiki/overview.md"):
|
||||
for name in ("ABOUT.md", "ABOUT.pl.md", "wiki/index.md", "wiki/overview.md"):
|
||||
p = self.root / name
|
||||
if p.is_file():
|
||||
parts.append(f"===== {name} =====\n{p.read_text(encoding='utf-8')}")
|
||||
|
|
|
|||
|
|
@ -90,25 +90,28 @@ for _var, _key in (("CKB_MCP_AUTHOR_NAME", "user.name"), ("CKB_MCP_AUTHOR_EMAIL"
|
|||
ENV[_var] = _r.stdout.strip()
|
||||
|
||||
|
||||
ABOUT_PLACEHOLDER = "One sentence on what this knowledge base holds and who it is for."
|
||||
ABOUT_PLACEHOLDERS = {
|
||||
"One sentence on what this knowledge base holds and who it is for.",
|
||||
"Jedno zdanie o tym, co zawiera ta baza wiedzy i dla kogo jest.",
|
||||
}
|
||||
|
||||
|
||||
def _kb_identity():
|
||||
"""(name, description) telling this KB apart when one client connects to several.
|
||||
Name: CKB_MCP_NAME, else the origin repo's name, else the folder name.
|
||||
Description: CKB_MCP_DESCRIPTION, else the tldr of ABOUT.md (unless still the
|
||||
scaffold's placeholder), else wiki/overview.md's tldr."""
|
||||
Description: CKB_MCP_DESCRIPTION, else the tldr of ABOUT.md, then of ABOUT.pl.md
|
||||
(unless still the scaffold's placeholder), else wiki/overview.md's tldr."""
|
||||
name = ENV.get("CKB_MCP_NAME")
|
||||
if not name:
|
||||
r = subprocess.run(["git", "-C", str(kb_store.root), "remote", "get-url", "origin"], capture_output=True, text=True)
|
||||
name = Path(r.stdout.strip()).name.removesuffix(".git") if r.returncode == 0 and r.stdout.strip() else kb_store.root.name
|
||||
desc = ENV.get("CKB_MCP_DESCRIPTION", "")
|
||||
for f in (kb_store.root / "ABOUT.md", kb_store.root / "wiki" / "overview.md"):
|
||||
for f in (kb_store.root / "ABOUT.md", kb_store.root / "ABOUT.pl.md", kb_store.root / "wiki" / "overview.md"):
|
||||
if desc or not f.is_file():
|
||||
continue
|
||||
m = re.search(r"^tldr:\s*(.+)$", f.read_text(encoding="utf-8").split("\n---", 1)[0], re.M)
|
||||
desc = m.group(1).strip().strip('"') if m else ""
|
||||
if desc == ABOUT_PLACEHOLDER:
|
||||
if desc in ABOUT_PLACEHOLDERS:
|
||||
desc = ""
|
||||
return re.sub(r"[^A-Za-z0-9_-]+", "-", name).strip("-") or "ckb", desc
|
||||
|
||||
|
|
|
|||
|
|
@ -51,7 +51,8 @@ Text between `<private>` and `</private>` in any source is never ingested:
|
|||
drop the span before synthesis, never quote it in `## Crux`, and never
|
||||
summarise it. If a whole file is private, leave it in the inbox and say so.
|
||||
|
||||
Read `ABOUT.md` at the KB root, if it exists and has been filled in. An
|
||||
Read `ABOUT.md` at the KB root, if it exists and has been filled in, and
|
||||
`ABOUT.pl.md` the same way (`ABOUT.md` wins where the two differ). An
|
||||
item outside its **Scope**, or one its **Sensitivity** section rules out,
|
||||
is not ingested silently: name it and the line of `ABOUT.md` it conflicts
|
||||
with, and ingest it only if the user says so. An item left out stays in
|
||||
|
|
|
|||
|
|
@ -234,6 +234,11 @@ actual project entity):
|
|||
later.)" Put an answer in its `tldr` and `## Purpose`, in the user's
|
||||
words, and leave every other section's comment in place. From then on
|
||||
the file is the user's.
|
||||
- `ABOUT.pl.md` - the same scaffold in Polish. Copy it and set
|
||||
`last_updated` the same way. If the user answered the question above in
|
||||
Polish, put the answer in this file rather than in `ABOUT.md`; either
|
||||
way, mention that they can fill in the one in their KB's language and
|
||||
delete the other.
|
||||
- `templates/README.md` and `templates/status-report.md` - the document
|
||||
template format and its one example, read by `ckb-document`. Copied once
|
||||
as a starting point; from then on they are the user's files.
|
||||
|
|
|
|||
|
|
@ -20,7 +20,7 @@ this in the wrong repo.
|
|||
2. **Never touch the template layer.** `AGENTS.md`, `CLAUDE.md`, `.agents/`,
|
||||
`.claude/`, `LICENSE`, `VERSION`, `README*`, `docs/`, `tests/`,
|
||||
`.gitignore`, `ckb.yaml`, `.git/`. Those *are* the template.
|
||||
3. **Never touch `src/`, `templates/` or `ABOUT.md`.** `src/` holds independent repositories
|
||||
3. **Never touch `src/`, `templates/`, `ABOUT.md` or `ABOUT.pl.md`.** `src/` holds independent repositories
|
||||
of code this skill has no business deleting. Not even with confirmation — tell
|
||||
the user to delete them with `rm -rf` themselves if that's really what they
|
||||
want. `templates/` holds the user's document templates, reusable across
|
||||
|
|
@ -158,7 +158,7 @@ and now the structure is broken too.
|
|||
|
||||
State: tiers reset, counts deleted per tier, scaffold files restored, the restore
|
||||
point hash (and tag, if one was made), lint result, and what was deliberately left
|
||||
alone (`src/`, `templates/`, `ABOUT.md`, modules, template layer).
|
||||
alone (`src/`, `templates/`, `ABOUT.md`, `ABOUT.pl.md`, modules, template layer).
|
||||
|
||||
**Do not append a workload summary.** Rule D's session note would be the first
|
||||
entry in a workload directory this skill just emptied, which defeats the purpose.
|
||||
|
|
|
|||
|
|
@ -177,7 +177,7 @@ v`Y`," clean up the scratch clone (Step 8), and stop.
|
|||
Skip this step entirely if Step 2 found no template upgrade — go straight
|
||||
to Step 5 with just the wiki-schema finding to present, if any.
|
||||
|
||||
The template layer is exactly these paths — never `ABOUT.md`, and never
|
||||
The template layer is exactly these paths — never `ABOUT.md` or `ABOUT.pl.md`, and never
|
||||
anything under `wiki/`, `raw/`, `outputs/`, `templates/`, `workload/`,
|
||||
`tmp/`, `libs/`, or `linked/`:
|
||||
|
||||
|
|
@ -302,6 +302,10 @@ Only if `template_upgrade_available` and at least one item was accepted:
|
|||
- If the KB has no `ABOUT.md`, create it from upstream's scaffold with
|
||||
`last_updated` set to today (template 1.21.0), and tell the user it is
|
||||
theirs to fill in. An existing `ABOUT.md` is never diffed or touched.
|
||||
- If the KB has no `ABOUT.pl.md`, create it the same way (template 1.26.2)
|
||||
and say once that it is the Polish pair, to fill in or delete. Never
|
||||
recreate it in a later upgrade if the owner deleted it: create it only
|
||||
when the KB's previous `VERSION` is below 1.26.2.
|
||||
- Leave every path outside the template layer completely untouched at
|
||||
this step — `wiki/` changes, if any, happen only in Step 7.
|
||||
- Update local `VERSION` to the template's new version last, only once
|
||||
|
|
|
|||
4
ABOUT.md
4
ABOUT.md
|
|
@ -11,6 +11,10 @@ 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
|
||||
|
|
|
|||
68
ABOUT.pl.md
Normal file
68
ABOUT.pl.md
Normal file
|
|
@ -0,0 +1,68 @@
|
|||
---
|
||||
type: about
|
||||
tldr: Jedno zdanie o tym, co zawiera ta baza wiedzy i dla kogo jest.
|
||||
last_updated: 2026-11-10
|
||||
---
|
||||
|
||||
# O tej bazie wiedzy
|
||||
|
||||
<!--
|
||||
Ten plik należy do ciebie. Mówi, do czego ta KB *służy*: cel, odbiorcy,
|
||||
zakres, właściciele, poufność. Nie mówi nic o tym, jak działa Cascade KB;
|
||||
to opisują README.pl.md, docs/ i AGENTS.md.
|
||||
|
||||
To polska wersja ABOUT.md. Wypełnij ten plik, który odpowiada językowi
|
||||
twojej bazy, a drugi możesz usunąć. Jeśli zostawisz oba wypełnione, agent
|
||||
czyta oba, a w razie rozbieżności pierwszeństwo ma ABOUT.md.
|
||||
|
||||
Agenci czytają ten plik i nigdy go nie edytują, chyba że o to poprosisz.
|
||||
Ingest sprawdza nowy materiał względem sekcji „Zakres” i „Poufność”; serwer
|
||||
MCP pokazuje go zdalnym klientom; wiki/overview.md streszcza, co KB
|
||||
faktycznie zawiera, i odsyła tutaj.
|
||||
|
||||
Zastąp każdy komentarz własnym tekstem albo usuń sekcję, która cię nie
|
||||
dotyczy. Zmieść się na jednej stronie. Po zmianie zaktualizuj `tldr` (jedno
|
||||
zdanie: pod nim klienci MCP widzą tę KB) i `last_updated`.
|
||||
-->
|
||||
|
||||
## Cel
|
||||
|
||||
<!-- Do czego służy ta KB, w dwóch–trzech zdaniach. Na jakie pytania
|
||||
powinna umieć odpowiedzieć? -->
|
||||
|
||||
## Odbiorcy
|
||||
|
||||
<!-- Kto ją czyta albo zadaje jej pytania: zespół, klient, nowe osoby,
|
||||
tylko ty. Co już wiedzą? -->
|
||||
|
||||
## Zakres
|
||||
|
||||
**W zakresie:**
|
||||
|
||||
<!-- Tematy, projekty, systemy, okres, które obejmuje ta KB. -->
|
||||
|
||||
**Poza zakresem:**
|
||||
|
||||
<!-- Co tu nie pasuje, nawet jeśli ktoś wrzuci to do inboxu, i gdzie
|
||||
powinno trafić zamiast tego, jeśli w ogóle. -->
|
||||
|
||||
## Właściciele i kontakty
|
||||
|
||||
<!-- Kto opiekuje się tą KB, kto decyduje, co do niej trafia, i kogo pytać
|
||||
o poszczególne obszary. Imiona i nazwiska albo role. -->
|
||||
|
||||
## Oczekiwane źródła
|
||||
|
||||
<!-- Skąd powinna pochodzić wiedza: notatki ze spotkań, witryna SharePoint,
|
||||
specyfikacje, wywiady. wiki/overview.md pokazuje, co faktycznie przetworzono. -->
|
||||
|
||||
## Poufność
|
||||
|
||||
<!-- Poziom poufności i zasady postępowania: czego nigdy tu nie
|
||||
przechowywać (dane logowania, dane osobowe, nazwy klientów poza ich
|
||||
projektem) i kto może oglądać tę KB. -->
|
||||
|
||||
## Język i terminy
|
||||
|
||||
<!-- Język, w którym pisane są strony wiki, oraz terminy i skróty, które
|
||||
czytelnik musi znać. -->
|
||||
|
|
@ -15,7 +15,7 @@ Maintain this root layout:
|
|||
|
||||
```
|
||||
├── .agents/modules/ # Optional modules, inert until installed
|
||||
├── ABOUT.md # User-authored: what this KB holds, for whom, scope, owners
|
||||
├── ABOUT.md # User-authored: what this KB holds, for whom, scope, owners (ABOUT.pl.md: Polish pair)
|
||||
├── ckb.yaml # Repo manifest: template branch, installed modules, conversation settings, routines
|
||||
├── docs/ # Manual, changelog, OpenSpec guide, template design records
|
||||
│ └── decisions/ # The template's own ADRs (D-0001…) — not KB content
|
||||
|
|
@ -86,7 +86,8 @@ I ask for") goes there, through `ckb-add-conversation`.
|
|||
read by `ckb-document` and never by retrieval.
|
||||
|
||||
`ABOUT.md` is the owner's statement of what this KB is for: purpose,
|
||||
audience, scope, owners, sensitivity. Read it, never edit it unless asked.
|
||||
audience, scope, owners, sensitivity. Read it, and `ABOUT.pl.md` if that is
|
||||
filled in (`ABOUT.md` wins on a conflict); never edit either unless asked.
|
||||
A question about the KB itself ("what is this KB for", "who owns it")
|
||||
is answered from it, then from `wiki/overview.md`. `ckb-ingest` checks new
|
||||
material against its scope and sensitivity.
|
||||
|
|
|
|||
|
|
@ -67,6 +67,7 @@ A KB with no `ckb.yaml` (or no `template:` block) is treated as tracking
|
|||
|
||||
```
|
||||
├── ABOUT.md # What this KB holds: purpose, audience, scope, owners - yours to write
|
||||
├── ABOUT.pl.md # The same in Polish - fill in the one in your KB's language
|
||||
├── ckb.yaml # Repo manifest: template branch tracked, installed modules, conversation settings, routines
|
||||
├── docs/ # Manual, changelog, OpenSpec guide, and decisions/ — the template's own ADRs
|
||||
├── tests/ # Template repo only: fixture KB + smoke test (tests/smoke.sh); not copied into KBs
|
||||
|
|
|
|||
|
|
@ -5,7 +5,7 @@
|
|||
**Repozytorium źródłowe (zawsze najbardziej aktualna wersja):**
|
||||
[git.wierzbowa.cloud/michal/ckb](https://git.wierzbowa.cloud/michal/ckb)
|
||||
|
||||
**Co zawiera ta baza wiedzy:** zobacz [ABOUT.md](ABOUT.md) - jej cel,
|
||||
**Co zawiera ta baza wiedzy:** zobacz [ABOUT.pl.md](ABOUT.pl.md) (lub [ABOUT.md](ABOUT.md)) - jej cel,
|
||||
odbiorców, zakres, właścicieli i poziom poufności, opisane przez osobę, która
|
||||
ją prowadzi. Reszta tego README opisuje narzędzia Cascade KB, takie same w
|
||||
każdej bazie.
|
||||
|
|
@ -70,6 +70,7 @@ KB bez `ckb.yaml` (albo bez bloku `template:`) jest traktowana jako śledząca
|
|||
|
||||
```
|
||||
├── ABOUT.md # Co zawiera ta KB: cel, odbiorcy, zakres, właściciele - piszesz go ty
|
||||
├── ABOUT.pl.md # To samo po polsku - wypełnij plik w języku swojej bazy
|
||||
├── ckb.yaml # Manifest repozytorium: śledzona gałąź szablonu, zainstalowane moduły, ustawienia rozmów, rutyny
|
||||
├── docs/ # Podręcznik, changelog, przewodnik OpenSpec i decisions/ — własne ADR-y szablonu
|
||||
├── tests/ # Tylko w repo szablonu: baza-fixture + test dymny (tests/smoke.sh); nie kopiowany do KB
|
||||
|
|
|
|||
2
VERSION
2
VERSION
|
|
@ -1 +1 @@
|
|||
1.26.1
|
||||
1.26.2
|
||||
|
|
|
|||
|
|
@ -340,7 +340,8 @@ docs. Independent of the content schema above.
|
|||
|
||||
| Version | Date | What landed | Schema |
|
||||
|---|---|---|---|
|
||||
| **1.26.1** | 2026-11-02 | Docs: a one-page quickstart, `docs/QUICKSTART.md` and `docs/QUICKSTART.pl.md`, from an empty folder to the first ingest, answer, lint and sync; linked from both READMEs and both manuals | 1.7 |
|
||||
| **1.26.2** | 2026-11-10 | `ABOUT.pl.md`: the Polish pair of the `ABOUT.md` scaffold, like the other `.pl.md` docs. Agents read both when both are filled in and `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 and never recreates a deleted one; `ckb-reset` leaves it alone; the `mcp` server's `kb_overview` includes it and its description falls back to its `tldr`, ignoring either placeholder. `README.pl.md` and `QUICKSTART.pl.md` point to it; both manuals list it | 1.7 |
|
||||
| 1.26.1 | 2026-11-02 | Docs: a one-page quickstart, `docs/QUICKSTART.md` and `docs/QUICKSTART.pl.md`, from an empty folder to the first ingest, answer, lint and sync; linked from both READMEs and both manuals | 1.7 |
|
||||
| 1.26.0 | 2026-11-02 | Agent-knowledge release 3, batch 3 (D-0017). **Capture module (F11):** new opt-in `.agents/modules/capture/` with skill `ckb-capture` and `capture_url.py`: a link becomes `raw/inbox/YYYY-MM-DD_<slug>.md` (`type: capture`, `source_url`, `fetched_on`, `fetched_via`, `untrusted: true`, a banner) from a stdlib fetch with readable-text extraction; the Wayback Machine's closest snapshot is used only when the live page failed or was thinner; `--from-file` wraps text the agent fetched itself; PDFs are saved as files; `--media` writes a timestamped transcript through `yt-dlp`, only with consent; one retry on 429/503. `dedup_inbox.py` compares a capture's `source_url` with archived captures and inbox twins, and capture removes its own duplicate. **Skill evals (F22):** `tests/run_evals.py` (`list`/`prepare`/`check`/`validate`) and five structural cases in `tests/evals/` (ingest batch, retrieve unanswerable and keep-answer, decide, retract), with a recorded reference run for `ckb-decide/record` (7/7). **Multi-agent (F18):** manual section with untested setups for Codex CLI, Cursor, OpenCode and Gemini CLI and a table of Claude Code-only features; `AGENTS.md` tells agents without skill loading to read `SKILL.md`. Smoke test covers capture against a local server and Wayback stand-in, and the eval runner both ways | 1.7 |
|
||||
| 1.25.0 | 2026-11-02 | Agent-knowledge release 3, batch 2: maintenance, **schema 1.7** (D-0016). New skill `ckb-consolidate` with `consolidate.py`: a proposals-only report in `outputs/reports/YYYY-MM-DD_consolidation.md` with topic clusters (scope members, shared tags, linked groups of three or more) and whether each topic page is missing, current or outdated, merge candidates (same type, title/`tldr` overlap ≥ 0.5), missing links (two shared sources, or one plus a shared scope), stale/drifted pages from lint, and old log entries by month (the log is never rewritten) (F13). Topic pages (`type: topic`) in the new `wiki/topics/`, built only on approval, with member-page digests in `## Sources` so lint flags drift; `ckb-retrieve` routes "what does the KB say overall" questions to `wiki/topics/index.md` first (F15). `ckb-upgrade` b4, `ckb-init`, `ckb-reset` know `wiki/topics/`; `ckb-routine` suggests a fortnightly `Consolidate --confirm`. Smoke test covers clustering, topic states and the report | 1.7 |
|
||||
| 1.24.0 | 2026-11-02 | Agent-knowledge release 3, batch 1: retrieval (D-0015). **Section search (F10):** `retrieve_candidates.py` adds a `bm25` list from a stdlib SQLite FTS5 index of page sections, with the page title, heading path and `tldr` in a separate context column (contextual retrieval); the cache `tmp/ckb-fts.sqlite` refreshes by mtime then sha256 (in memory without `tmp/`, skipped without FTS5); candidates list up to three `#anchor (Heading)` section hits. New benchmark `tests/bench_retrieval.py` over `tests/fixtures/bench-kb/` (12 pages, 20 questions): hit@1 14/20 and hit@3 20/20 with and without bm25. Weight kept at 1.0 rather than tuned; the misses come from the `tldr` signal over-matching generic words. **Token costs (F12):** `~N tok` per candidate; the skill reads index → section → page. **Access log (F16):** `--opened PATH…` appends pages read to the per-machine `tmp/access.log`; `lint_report.py --cold [DAYS]` proposes moving unread pages to a `## Archive` index section, never moves anything. **Answer formats (F17):** `ckb-retrieve` offers a table, chart, deck or HTML page once when the answer has that shape. Smoke test covers the index cache, section hits, the access log, cold proposals and the benchmark | 1.6 |
|
||||
|
|
|
|||
|
|
@ -348,7 +348,8 @@ Niezależna od schematu treści powyżej.
|
|||
|
||||
| Wersja | Data | Co weszło | Schemat |
|
||||
|---|---|---|---|
|
||||
| **1.26.1** | 2026-11-02 | Dokumentacja: jednostronicowy szybki start, `docs/QUICKSTART.md` i `docs/QUICKSTART.pl.md`, od pustego folderu do pierwszego ingestu, odpowiedzi, lintu i synchronizacji; linki z obu README i obu podręczników | 1.7 |
|
||||
| **1.26.2** | 2026-11-10 | `ABOUT.pl.md`: polska para szablonu `ABOUT.md`, jak pozostałe dokumenty `.pl.md`. Gdy oba są wypełnione, agent czyta oba, a przy rozbieżności wygrywa `ABOUT.md` (`AGENTS.md`, `ckb-ingest`); `ckb-init` kopiuje oba i wpisuje odpowiedź po polsku do polskiego pliku; `ckb-upgrade` tworzy go raz w KB poniżej 1.26.2 i nigdy nie odtwarza usuniętego; `ckb-reset` go nie rusza; w module `mcp` `kb_overview` go zawiera, a opis serwera bierze jego `tldr`, pomijając oba placeholdery. `README.pl.md` i `QUICKSTART.pl.md` do niego odsyłają; oba podręczniki go wymieniają | 1.7 |
|
||||
| 1.26.1 | 2026-11-02 | Dokumentacja: jednostronicowy szybki start, `docs/QUICKSTART.md` i `docs/QUICKSTART.pl.md`, od pustego folderu do pierwszego ingestu, odpowiedzi, lintu i synchronizacji; linki z obu README i obu podręczników | 1.7 |
|
||||
| 1.26.0 | 2026-11-02 | Wiedza dla agentów, wydanie 3, partia 3 (D-0017). **Moduł capture (F11):** nowy opcjonalny `.agents/modules/capture/` ze skillem `ckb-capture` i `capture_url.py`: link staje się plikiem `raw/inbox/YYYY-MM-DD_<slug>.md` (`type: capture`, `source_url`, `fetched_on`, `fetched_via`, `untrusted: true`, baner) z pobrania biblioteką standardową z wydobyciem czytelnego tekstu; najbliższy zrzut Wayback Machine jest używany tylko, gdy żywa strona zawiodła lub była uboższa; `--from-file` opakowuje tekst pobrany przez samego agenta; PDF-y są zapisywane jako pliki; `--media` zapisuje transkrypcję ze znacznikami czasu przez `yt-dlp`, tylko za zgodą; jedna ponowna próba przy 429/503. `dedup_inbox.py` porównuje `source_url` zrzutu z zarchiwizowanymi zrzutami i bliźniakami w skrzynce, a capture usuwa własny duplikat. **Ewaluacje skilli (F22):** `tests/run_evals.py` (`list`/`prepare`/`check`/`validate`) i pięć strukturalnych przypadków w `tests/evals/` (ingest wsadowy, retrieve bez odpowiedzi i z zachowaniem odpowiedzi, decide, retract), z zapisanym przebiegiem wzorcowym dla `ckb-decide/record` (7/7). **Wielu agentów (F18):** sekcja podręcznika z nieprzetestowanymi konfiguracjami dla Codex CLI, Cursor, OpenCode i Gemini CLI oraz tabelą funkcji tylko dla Claude Code; `AGENTS.md` każe agentom bez wczytywania skilli czytać `SKILL.md`. Test dymny obejmuje capture z lokalnym serwerem i zastępczym Wayback oraz runner ewaluacji w obie strony | 1.7 |
|
||||
| 1.25.0 | 2026-11-02 | Wiedza dla agentów, wydanie 3, partia 2: utrzymanie, **schemat 1.7** (D-0016). Nowy skill `ckb-consolidate` z `consolidate.py`: raport samych propozycji w `outputs/reports/YYYY-MM-DD_consolidation.md` z grupami tematów (członkowie zakresu, wspólne tagi, połączone grupy od trzech stron) i stanem każdej strony tematu (brak, aktualna, nieaktualna), kandydatami do scalenia (ten sam typ, podobieństwo tytułu/`tldr` ≥ 0,5), brakującymi linkami (dwa wspólne źródła albo jedno plus wspólny zakres), stronami nieaktualnymi lub z dryfem z lintu i starymi wpisami dziennika według miesięcy (dziennik nigdy nie jest przepisywany) (F13). Strony tematów (`type: topic`) w nowym `wiki/topics/`, budowane tylko po akceptacji, ze skrótami stron członkowskich w `## Sources`, więc lint wykrywa dryf; `ckb-retrieve` kieruje pytania „co KB mówi ogólnie” najpierw do `wiki/topics/index.md` (F15). `ckb-upgrade` b4, `ckb-init`, `ckb-reset` znają `wiki/topics/`; `ckb-routine` podsuwa rutynę `Consolidate --confirm` co 14 dni. Test dymny obejmuje grupowanie, stany tematów i raport | 1.7 |
|
||||
| 1.24.0 | 2026-11-02 | Wiedza dla agentów, wydanie 3, partia 1: wyszukiwanie (D-0015). **Wyszukiwanie po sekcjach (F10):** `retrieve_candidates.py` dodaje listę `bm25` z indeksu SQLite FTS5 (biblioteka standardowa) po sekcjach stron, z tytułem strony, ścieżką nagłówków i `tldr` w osobnej kolumnie kontekstu (contextual retrieval); pamięć podręczna `tmp/ckb-fts.sqlite` odświeża się po mtime, potem sha256 (w pamięci bez `tmp/`, pomijana bez FTS5); kandydaci wymieniają do trzech trafionych sekcji `#kotwica (Nagłówek)`. Nowy benchmark `tests/bench_retrieval.py` na `tests/fixtures/bench-kb/` (12 stron, 20 pytań): hit@1 14/20 i hit@3 20/20 z bm25 i bez. Waga zostaje 1.0, bez strojenia pod zestaw; chybienia biorą się z sygnału `tldr`, który łapie ogólne słowa. **Koszt w tokenach (F12):** `~N tok` przy każdym kandydacie; skill czyta indeks → sekcja → strona. **Dziennik odczytów (F16):** `--opened ŚCIEŻKA…` dopisuje przeczytane strony do `tmp/access.log` (per maszyna); `lint_report.py --cold [DNI]` proponuje przeniesienie nieczytanych stron do sekcji `## Archive` indeksu i niczego nie przenosi. **Formaty odpowiedzi (F17):** `ckb-retrieve` raz proponuje tabelę, wykres, prezentację lub stronę HTML, gdy odpowiedź ma taki kształt. Test dymny obejmuje pamięć indeksu, trafienia sekcji, dziennik odczytów, propozycje `--cold` i benchmark | 1.6 |
|
||||
|
|
|
|||
|
|
@ -1129,7 +1129,7 @@ generated page will be overwritten.
|
|||
| `outputs/okf/`, `outputs/starlight/` | Agent, **fully regenerated** | Don't hand-edit - these are gitignored build artifacts, silently overwritten the next time you export. If something's wrong, fix the wiki page it came from and re-export. |
|
||||
| `outputs/teaching/<topic>/` | Agent, semi-persistent state | `plan.md`/`progress.md` the teaching skill reads and writes across sessions. You can look at them any time; hand-editing is possible but may confuse "what's next" tracking - safer to tell the agent what you want changed and let it update the files. |
|
||||
| `PROJECT-OVERVIEW.md` (repo root) | Agent, **fully regenerated** | Overwritten in full each time you ask for a project summary. Don't hand-edit it - edit the wiki pages it's synthesised from instead, then regenerate. |
|
||||
| `ABOUT.md` | **You** | What this KB is for: purpose, audience, scope, owners, sensitivity, the language pages are written in. The README links to it. The agent reads it, checks new material against its scope at ingest, and never edits it unless you ask; upgrades and resets leave it alone. `wiki/overview.md` is the agent's summary of what the KB actually holds. |
|
||||
| `ABOUT.md`, `ABOUT.pl.md` | **You** | The same file in English and Polish: fill in the one in your KB's language and delete the other if you like (if both are filled in, `ABOUT.md` wins on a conflict). What this KB is for: purpose, audience, scope, owners, sensitivity, the language pages are written in. The README links to it. The agent reads it, checks new material against its scope at ingest, and never edits it unless you ask; upgrades and resets leave it alone. `wiki/overview.md` is the agent's summary of what the KB actually holds. |
|
||||
| `templates/` | **You** | Document templates: headings, plus a comment per section saying what goes there and where it comes from. The agent reads them, and writes a new one only when you ask. Nothing regenerates or resets this folder. Start from `templates/status-report.md`. |
|
||||
| `outputs/documents/` | Agent (one file per request), **you can edit** | Documents prepared from a template. Tracked in git and never overwritten by a later run (a repeated name gets `-2`, `-3`). Edit them freely; the frontmatter records which template and which wiki pages they came from. |
|
||||
| `workload/YYYY-MM-DD_<author>_summary.md` | Agent (appended each session) | A running journal of what happened each day, one file per person so a shared repo records who did what and never conflicts here. The author is the git identity of the session. You can read, edit, or trim it freely - it's a log for continuity, not a machine-critical file. |
|
||||
|
|
|
|||
|
|
@ -1181,7 +1181,7 @@ na stronie generowanej, zostanie nadpisane.
|
|||
| `outputs/okf/`, `outputs/starlight/` | Agent, **w pełni regenerowane** | Nie edytuj ręcznie — to zignorowane przez git artefakty budowania, cicho nadpisywane przy każdym kolejnym eksporcie. Jeśli coś jest nie tak, popraw stronę wiki, z której to pochodzi, i wyeksportuj ponownie. |
|
||||
| `outputs/teaching/<topic>/` | Agent, stan półtrwały | `plan.md`/`progress.md`, które skill do nauczania czyta i zapisuje między sesjami. Możesz je oglądać kiedy chcesz; ręczna edycja jest możliwa, ale może pomieszać śledzenie „co dalej” — bezpieczniej powiedzieć agentowi, co chcesz zmienić, i pozwolić mu zaktualizować pliki. |
|
||||
| `PROJECT-OVERVIEW.md` (katalog główny) | Agent, **w pełni regenerowany** | Nadpisywany w całości za każdym razem, gdy poprosisz o podsumowanie projektu. Nie edytuj go ręcznie — edytuj strony wiki, z których jest syntetyzowany, a potem zregeneruj. |
|
||||
| `ABOUT.md` | **Ty** | Do czego służy ta KB: cel, odbiorcy, zakres, właściciele, poufność, język stron. README do niego linkuje. Agent go czyta, przy ingeście sprawdza nowy materiał względem zakresu i nigdy go nie edytuje bez twojej prośby; aktualizacje i reset go nie ruszają. `wiki/overview.md` to podsumowanie agenta tego, co KB faktycznie zawiera. |
|
||||
| `ABOUT.md`, `ABOUT.pl.md` | **Ty** | Ten sam plik po angielsku i po polsku: wypełnij ten w języku swojej bazy, drugi możesz usunąć (jeśli oba są wypełnione, przy rozbieżności wygrywa `ABOUT.md`). Do czego służy ta KB: cel, odbiorcy, zakres, właściciele, poufność, język stron. README do niego linkuje. Agent go czyta, przy ingeście sprawdza nowy materiał względem zakresu i nigdy go nie edytuje bez twojej prośby; aktualizacje i reset go nie ruszają. `wiki/overview.md` to podsumowanie agenta tego, co KB faktycznie zawiera. |
|
||||
| `templates/` | **Ty** | Szablony dokumentów: nagłówki plus komentarz pod każdą sekcją mówiący, co ma tam trafić i skąd. Agent je czyta, a nowy zapisuje tylko na twoją prośbę. Nic nie regeneruje ani nie resetuje tego katalogu. Zacznij od `templates/status-report.md`. |
|
||||
| `outputs/documents/` | Agent (jeden plik na prośbę), **możesz edytować** | Dokumenty przygotowane z szablonu. Śledzone w gicie i nigdy nie nadpisywane przez kolejne uruchomienie (powtórzona nazwa dostaje `-2`, `-3`). Edytuj je swobodnie; frontmatter zapisuje, z jakiego szablonu i z jakich stron wiki powstały. |
|
||||
| `workload/YYYY-MM-DD_<autor>_summary.md` | Agent (dopisywane co sesję) | Bieżący dziennik tego, co działo się każdego dnia, jeden plik na osobę, więc współdzielone repozytorium zapisuje, kto co zrobił, i nigdy nie konfliktuje w tym miejscu. Autor to tożsamość gita sesji. Możesz go swobodnie czytać, edytować lub skracać — to dziennik dla ciągłości, a nie plik krytyczny dla działania systemu. |
|
||||
|
|
|
|||
|
|
@ -56,7 +56,7 @@ git config --global user.email "ty@example.com"
|
|||
|
||||
## 3. Napisz, do czego służy baza
|
||||
|
||||
Otwórz `ABOUT.md` i zastąp komentarze kilkoma własnymi zdaniami: do czego
|
||||
Otwórz `ABOUT.pl.md` (polską wersję `ABOUT.md`) i zastąp komentarze kilkoma własnymi zdaniami: do czego
|
||||
jest ta baza, kto ją czyta, co do niej należy, a co nie, i co jest poufne.
|
||||
Akapit na sekcję w zupełności wystarczy.
|
||||
|
||||
|
|
@ -123,6 +123,6 @@ Nigdy nie wypycha niczego bez twojej prośby.
|
|||
|
||||
- [Podręcznik](MANUAL.pl.md) opisuje każde zadanie szczegółowo, od
|
||||
zapisywania decyzji po podłączanie cudzych baz.
|
||||
- `ABOUT.md` należy do ciebie: aktualizuj go, gdy baza rośnie.
|
||||
- `ABOUT.pl.md` (i `ABOUT.md`) należy do ciebie: aktualizuj go, gdy baza rośnie.
|
||||
- [Changelog](CHANGELOG.pl.md) wymienia wszystkie pola stron i zmiany w
|
||||
każdym wydaniu.
|
||||
|
|
|
|||
Loading…
Add table
Reference in a new issue