Ƒééđ çöñţéñţ ţö ýöüŕ ÀÎ

Ĝöàļ: ţüŕñ àñý đöçüḿéñţ (Ŵöŕđ, ÞĐƑ, ĴŠÖÑ, Ḿàŕķđöŵñ, ĤŢḾĻ) îñţö à šţŕéàḿ öƒ çļéàñ, àñçĥöŕéđ çöñţéñţ ƃļöçķš àñ ÀÎ àššîšţàñţ öŕ ŔÀĜ þîþéļîñé çàñ ŕéàđ ŵîţĥöüţ ķñöŵîñĝ àñýţĥîñĝ àƃöüţ ţĥé šöüŕçé ƒöŕḿàţ. Ñö ţŕàñšļàţîöñ îš îñṽöļṽéđ. Éṽéŕý ƃļöçķ çàŕŕîéš à ŕéƒéŕéñçé (ref: îţš đöçüḿéñţ àñđ îţš ķéý) àñđ ţĥé ŕéṽîšîöñ öƒ îţš ţéẋţ (rev), šö àñ éđîţ þŕöđüçéđ ļàţéŕ çàñ ƃé ŵŕîţţéñ ƃàçķ ţö ţĥé šàḿé ƃļöçķ ŵîţĥ ţĥé šüŕŕöüñđîñĝ ḿàŕķüþ îñţàçţ, àñđ ŕéƒüšéđ îƒ ţĥé ƃļöçķ çĥàñĝéđ îñ ƃéţŵééñ. Çöñçéþţš: Çöñţéñţ ḿöđéļ, Çĥéçķš.

Đéšķţöþ

Îñ Ķàþî Đéšķţöþ ýöü çĥéçķ ŵĥàţ ýöüŕ ÀÎ ŵîļļ ŕéàđ ƃéƒöŕé ýöü îñđéẋ îţ:

1. Šéé ŵĥàţ ýöüŕ ÀÎ ŵîļļ šéé. Öþéñ à ƒîļé îñ ýöüŕ þŕöĵéçţ: ţĥé Ƃļöçķš ṽîéŵ ļîšţš ţĥé ƃļöçķš kapi inspect ŕéàđš, éàçĥ ŵîţĥ îţš ţéẋţ àñđ šţŕüçţüŕàļ ŕöļé àñđ ţĥé šüŕŕöüñđîñĝ ḿàŕķüþ šţŕîþþéđ àŵàý.
2. Ĵüđĝé ţĥé þàŕšé ƃéƒöŕé ýöü îñđéẋ. Þŕéṽîéŵ (þļüš Šţŕüçţüŕé àñđ Ļàýöüţ ŵĥéŕé ţĥé ƒöŕḿàţ çàŕŕîéš ţĥéḿ) šĥöŵš ŵĥéţĥéŕ ĥéàđîñĝš, ţàƃļéš, àñđ ŕéàđîñĝ öŕđéŕ çàḿé ţĥŕöüĝĥ. À þàŕšé þŕöƃļéḿ îš çĥéàþéŕ ţö ƒîẋ ĥéŕé ţĥàñ àƒţéŕ îţ šĥöŵš üþ îñ ŕéţŕîéṽàļ.
3. Ţĥéñ šţŕéàḿ. Ţĥé ƒééđ îţšéļƒ îš kapi inspect --jsonl (ÇĻÎ ţàƃ), öŕ à çöññéçţéđ àššîšţàñţ ŕéàđîñĝ ƃļöçķš đîŕéçţļý (Àĝéñţ ţàƃ).

Àĝéñţ (Çļàüđé)

À çöññéçţéđ àššîšţàñţ ñééđš ñö éẋþöŕţ šţéþ: ţĥé ḾÇÞ ţööļš àŕé ţĥé ƒééđ:

• read_blocks ŕéàđš ţĥé àñçĥöŕéđ ƃļöçķš öƒ àñý ƒîļé îţ îš þöîñţéđ àţ, à þàĝé àţ à ţîḿé;
• check_file ŕéţüŕñš ţĥé šţŕüçţüŕéđ kapi.check/v2 Ŕéþöŕţ, öñé ƒîñđîñĝ þéŕ ƃļöçķ;
• apply_edits ŵŕîţéš ŕéṽîšîöñš ƃàçķ ţĥŕöüĝĥ ţĥé ŕöüñđ-ţŕîþ, éàçĥ ĝüàŕđéđ ƃý ţĥé ŕéṽîšîöñ read_blocks ŕéþöŕţéđ.

Ýöü đéšçŕîƃé ţĥé öüţçöḿé ("ŕéàđ ţĥé çöñţŕàçţ àñđ ƒļàĝ éṽéŕý çļàüšé ţĥàţ ḿéñţîöñš ļîàƃîļîţý") àñđ ţĥé àššîšţàñţ ŕéàđš ţĥé ƃļöçķš, ŵîţĥ ñö ḿàŕķüþ ţö šţŕîþ.

ÇĻÎ

Šüŕṽéý ƒîŕšţ. kapi stats šîžéš ţĥé ĵöƃ (ƃļöçķš, ŵöŕđš, çĥàŕàçţéŕš, à ƃŕéàķđöŵñ ƃý šţŕüçţüŕàļ ŕöļé) ţö éšţîḿàţé ţöķéñ ƃüđĝéţ àñđ đéçîđé ĥöŵ ţö çĥüñķ:

kapi stats --json report.docx docs/*.md | jq '.total.words'

Éẋţŕàçţ ƃļöçķš ŵîţĥ àñçĥöŕš. kapi inspect éḿîţš öñé ŕéçöŕđ þéŕ ƃļöçķ: ţĥé ƃļöçķ'š ref àñđ rev, ţĥé text ŵîţĥ îñļîñé çöđéš àš <x id="…"/> þļàçéĥöļđéŕš, ţĥé šţŕüçţüŕàļ role àñđ ţĥé ñéšţîñĝ level. À Ŵöŕđ đöçüḿéñţ, à ĴŠÖÑ çàţàļöĝ àñđ à Ḿàŕķđöŵñ þàĝé àļļ ýîéļđ ţĥé šàḿé ŕéçöŕđ šĥàþé. --jsonl šţŕéàḿš öñé öƃĵéçţ þéŕ ļîñé ƒöŕ þîþéļîñéš; -f đéçļàŕéš ţĥé ƒöŕḿàţ ŵĥéñ đéţéçţîöñ îš àḿƃîĝüöüš:

kapi inspect --jsonl report.docx docs/*.md | \
  jq -c '{doc: .ref.doc, block: .ref.block, role: .role, text: .text}'
cat page.html | kapi inspect -f html --jsonl

Ŵŕîţé ƃàçķ; çĥéçķ àñý ţîḿé. kapi apply ļàñđš àñ àššîšţàñţ'š éđîţš öñ ţĥé öŕîĝîñàļ ƃļöçķš ƃý ŕéƒéŕéñçé; kapi check ŕéţüŕñš ƒîñđîñĝš à þŕöĝŕàḿ çàñ àçţ öñ (éẋîţ 0 þàšš, 3 ĝàţé ţŕîþþéđ, --no-fail ƒöŕ ƒîẋ-ļööþš):

kapi apply edits.json --dry-run           # review before writing
kapi check report.docx --max-chars 300 --forbid "TODO"

Àñ éđîţ ţö à ƃļöçķ ţĥàţ çĥàñĝéđ šîñçé ýöü ŕéàđ îţ, öŕ ţĥàţ ŵöüļđ çöŕŕüþţ àñ îñļîñé çöđé, îš ŕéƒüšéđ; Éđîţ çöñţéñţ đöçüḿéñţš ţĥé çĥàñĝé šéţ'š šĥàþé àñđ ŵĥàţ ŕéƒüšéš àñ éđîţ.

Îñ à þŕöĵéçţ

Îñ à ķàþî þŕöĵéçţ, kapi stats, kapi inspect, àñđ kapi check ŵîţĥ ñö ƒîļé àŕĝüḿéñţ šüŕṽéý éṽéŕý šöüŕçé ţĥé ŕéçîþé đéçļàŕéš. À ƃļöçķ'š ŕéƒéŕéñçé îš îţš þŕöĵéçţ-ŕéļàţîṽé þàţĥ àñđ îţš ķéý, ŵĥîçĥ šţàýš ţĥé šàḿé àçŕöšš ŕüñš ŵĥîļé ţĥé ƃļöçķ îš ţĥéŕé, šö àñ àššîšţàñţ îñđéẋîñĝ ýöüŕ þŕöĵéçţ çàñ ŕéţŕîéṽé àñđ ŕéŵŕîţé ţĥé šàḿé ƃļöçķš öṽéŕ ţîḿé.

Ƒüŕţĥéŕ ŕéàđîñĝ

• Éđîţ çöñţéñţ: ţĥé îñšþéçţ → éđîţ → apply ļööþ àñđ ţĥé þŕéšéŕṽàţîöñ çöñţŕàçţ.
• ḾÇÞ šéŕṽéŕ: éṽéŕý šţŕüçţüŕéđ ţööļ ƃéĥîñđ ţĥé šàḿé ļööþ.
• Ŵĥàţ ĝéţš ţŕàñšļàţéđ: ŵĥéñ ýöüŕ ĝöàļ îš ţŕàñšļàţîöñ.