docs: rewrite the onboarding set in Korean, for the agent author#103
Merged
Conversation
The docs described 0.2.x while the package shipped 0.3.0, counted 27 methods where there are 33, and stopped at four authority types where there are six. Worse, the parts that make this package unusual — the `discipline` strings the envelope carries, the intent gate that decides what a bundle loads, the character-not-byte payload threshold — were scattered across pages that were each about something else. Rewrite all of it in Korean, aimed at the reader the package was actually built for: someone wiring it into an LLM agent. - README: banner, why the surface is task-level, what the three agent constraints buy you, accurate 0.3.0 coverage - docs/wiki: 11 pages rewritten from the code, plus two new ones — Agent-Integration (envelope signals, catalog contract, exit codes, context budget, intent gate) and Architecture (four tiers, 22 mixins, what normalization actually untangles) - CONTRIBUTING, SECURITY, CODE_OF_CONDUCT, CHANGELOG: new. Branch naming was three coexisting schemes and the release procedure lived nowhere, which is plausibly why a tag once shipped without a Release - pyproject: Documentation URL pointed at /tree/main/wiki, which 404s on PyPI — the directory is docs/wiki Also records two things left unfixed: catalog's `kinds` list omits `catalog` and `version_request_unfulfilled`, and a bare `pytest` runs the live suite because no addopts excludes it. Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
무엇을
문서 전체를 실제 코드 기준으로 다시 썼습니다. 언어는 한국어, 파일명은 영어 유지(링크·북마크 보존).
왜
기존 문서는 구조가 아니라 정확성과 누락이 문제였습니다.
Home.md가 "alpha0.2.x" — 실제는0.3.0(CLI-Reference.md는 0.3.0이라 문서끼리 불일치)Home.md·Core-Concepts.md의 권위 유형이 4종에 멈춤 — 위원회 의결·행정심판 재결 없음Documentation이/tree/main/wiki를 가리킴 — 실제 경로는docs/wikiCore-Concepts.md말미가 자기 자신을 가리킴Installation.md오기addopts가 없어 실제로는 실행됨그리고 이 패키지에서 가장 독창적인 부분이 가장 덜 문서화돼 있었습니다 — 엔벨로프가 나르는
discipline문자열, 질의 키워드가 로드 범위를 정하는 의도 게이트, 20,000자 임계값을 바이트가 아니라 문자로 재는 이유(한글 3바이트). 전부 다른 주제의 페이지에 흩어져 있었습니다.변경
README — 배너, 왜 표면이 과업 단위인지, 에이전트의 세 제약이 무엇을 사는지, 정확한 0.3.0 커버리지
docs/wiki — 11개 전면 재작성 + 신규 2개
Agent-Integration.md—flags·discipline·next세 신호,catalog계약, 종료코드 5종과 각각의 대응,load-followup파이프, 컨텍스트 예산(실측 포함), 의도 게이트, 답 쓰기 전 점검표Architecture.md— 4계층 구조, 22개 믹스인 합성, 정규화 계층이 실제로 푸는 문제,MolegSource주입 지점, 알려진 중복루트 신규 —
CONTRIBUTING.mdSECURITY.mdCODE_OF_CONDUCT.mdCHANGELOG.mdpyproject.toml— Documentation URL 수정고치지 않고 기록만 한 것
코드 변경이라 범위 밖으로 뒀고, 문서에 알려진 차이로 명시했습니다.
catalog의kinds목록에 실제 배출되는catalog와version_request_unfulfilled가 빠져 있음 —catalog를 "단일 진실 공급원"으로 문서화하는 이상 실제 계약 위반addopts에-m "not live"가 없어 맨몸pytest가 라이브 스위트를 돌림검증
_Sidebar·Home·README 내비게이션 누락 0건pytest -m "not live"→ 511 passed🤖 Generated with Claude Code