ckb/docs/QUICKSTART.pl.md
Michał Kopeć 56c0511ac7 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>
2026-11-10 09:35:57 +01:00

128 lines
5.1 KiB
Markdown

# Szybki start
*Czytaj w: [English](QUICKSTART.md) | **Polski***
Ta strona prowadzi od pustego folderu do bazy wiedzy, która odpowiada na
pytania na podstawie twoich materiałów. Opisuje tylko pierwszą sesję.
Resztę znajdziesz w [podręczniku](MANUAL.pl.md).
Rozmawiasz z agentem AI zwykłym językiem, a on wszystko porządkuje.
Polecenia w cudzysłowach to przykłady. Agent rozumie intencję, więc nie
musisz trzymać się dokładnych słów.
## Czego potrzebujesz
- Agenta AI, który czyta `AGENTS.md`. Claude Code obsługuje wszystkie funkcje.
Codex CLI, Cursor, OpenCode i Gemini CLI też powinny działać; zobacz „Praca
z agentem innym niż Claude Code” w podręczniku.
- Gita.
- Pythona 3.8 lub nowszego. Nie jest wymagany, ale warto go mieć: lint,
wyszukiwanie i kilka innych kontroli to skrypty, a bez Pythona agent robi je
ręcznie i wolniej. Instrukcje instalacji dla Windows, macOS i Linuksa są w
sekcji [Wymagania wstępne](MANUAL.pl.md#wymagania-wstępne) podręcznika.
## 1. Utwórz bazę wiedzy
Pobierz kopię szablonu i otwórz w niej swojego agenta:
```bash
git clone https://git.wierzbowa.cloud/michal/ckb.git ckb-template
cd ckb-template
```
Potem poproś o nową, pustą bazę w wybranym folderze:
> „Set up a new wiki like this one in `~/kbs/team-notes`.”
Agent kopiuje strukturę, zasady i skille, ale żadnej treści szablonu. Przed
`git init` zapyta o zgodę. Od tej pory pracujesz w nowym folderze, a
`ckb-template` możesz usunąć.
## 2. Zacznij sesję
Otwórz agenta w `~/kbs/team-notes` i napisz cokolwiek. Zanim odpowie, agent
robi krótki przegląd: kim jesteś (na podstawie tożsamości w gicie), czy coś
nie jest zacommitowane i czy wiki ma jakieś problemy. Pierwsza odpowiedź
zaczyna się jednolinijkowym tytułem rozmowy. Możesz go zmienić: „rename this
conversation to notatki z onboardingu”.
Jeśli tożsamość w gicie nie jest ustawiona, agent to powie. Ustaw ją raz,
bo trafia do każdego wpisu w dzienniku:
```bash
git config --global user.name "Imię Nazwisko"
git config --global user.email "ty@example.com"
```
## 3. Napisz, do czego służy baza
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.
To jedyny plik, który agent czyta, ale nigdy nie przepisuje. Ingest sprawdza
z nim nowy materiał, więc plik z innego projektu zostanie zauważony, zamiast
po cichu trafić do wiki.
## 4. Dodaj materiały
Wrzuć pliki do `raw/inbox/`: notatki ze spotkań, PDF, wyeksportowany czat,
plik `.txt` z linkami. Nie musisz ich porządkować. Potem powiedz:
> „Ingest.”
Agent najpierw opisuje w kilku linijkach, jak zrozumiał każdy plik, które
strony zamierza utworzyć lub zmienić i z czym się nie zgadza. Potem czeka. To
najlepszy moment na poprawki, dużo tańszy niż późniejsze łatanie stron. Gdy
dasz zielone światło, zapisuje strony w `wiki/`, notuje skrót każdego źródła,
przenosi pliki do `raw/archive/<data>/` i zostawia raport w
`workload/ingest-reports/`.
Masz link, a nie plik? Zainstaluj raz moduł capture („install the capture
module”), a potem powiedz „capture this link: https://…”. Strona trafi do
skrzynki jako datowany zrzut, gotowy do następnego ingestu.
## 5. Zadawaj pytania
Pytaj tak, jak pytasz kolegę z zespołu:
> „Co ustaliliśmy w sprawie dostępów dla nowych osób?”
Agent znajduje strony, sprawdza je z plikami, z których powstały, i
odpowiada, podając źródła. Mówi też, gdy strona jest stara, nieprzejrzana albo
czemuś przeczy. Jeśli baza czegoś nie wie, przyznaje to i zapisuje lukę w
`wiki/query-gaps.md`, więc wiesz, co dodać w następnej kolejności.
Odpowiedź warta zachowania? Powiedz „keep this answer”, a trafi do
`outputs/answers/` razem ze źródłami.
## 6. Dbaj o porządek
Co jakiś czas powiedz „Lint”. Agent sprawdza całą wiki: zepsute linki, stare
strony, źródła zmienione pod istniejącą stroną, cytaty, które przestały się
zgadzać, przypadkowo zacommitowane sekrety. Naprawia to, co może bezpiecznie,
a o resztę pyta.
Strony napisane przez agenta zaczynają jako szkice. „What needs review?”
wypisuje je, a „mark the access-requests page as reviewed” zapisuje, że
przeczytałeś daną stronę.
Żeby nie musieć o tym pamiętać, zrób z tego rutynę: „lint every week”.
Uruchomi się na pierwszej sesji po upływie siedmiu dni.
## 7. Podziel się bazą
Powiedz „sync changes”. Agent sprawdza, czy nie ma sekretów, commituje,
pobiera nowe zmiany i wypycha twoje. Przy pierwszej synchronizacji zapyta o
adres zdalnego repozytorium. Potem każdy, kto pracuje w bazie, używa tego
samego polecenia, żeby wysłać swoje zmiany i dostać cudze.
Nigdy nie wypycha niczego bez twojej prośby.
## Co dalej
- [Podręcznik](MANUAL.pl.md) opisuje każde zadanie szczegółowo, od
zapisywania decyzji po podłączanie cudzych baz.
- `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.