Skip to content

Sync Phase 3 user-facing docs (examples, TypeScript SDK, status)#494

Open
hiroshitanaka-creator wants to merge 1 commit intomainfrom
codex/synchronize-user-facing-truth-in-documentation
Open

Sync Phase 3 user-facing docs (examples, TypeScript SDK, status)#494
hiroshitanaka-creator wants to merge 1 commit intomainfrom
codex/synchronize-user-facing-truth-in-documentation

Conversation

@hiroshitanaka-creator
Copy link
Copy Markdown
Owner

Motivation

  • user-facingドキュメントの一貫性をリポジトリの release SSOT (1.0.2 / package version) と evidence-boundary(PyPI 公開のみ確証)および public roster 表現(“42 integrated runtime personas” / NORMAL 既定で最大39 active)に合わせて最小差分で整備するため。
  • SDK README と examples のインストール案内が pyproject.toml による配布導線や認証デフォルト(PO_SKIP_AUTH=false)を明確に示しておらず、これを明確化する必要があったため。

Description

  • examples/README.md のインストール説明を補強し、requirements.txt / requirements-dev.txt を「repo-local convenience wrappers」と明記して外部利用者向けには pip install "po-core-flyingpig==1.0.2" または extras を推奨する文言を追加した。
  • examples/README.md 内の哲学者表現を公開向けの canonical wording に合わせて 42 の統合済みランタイム・ペルソナ とし、NORMAL 既定で 最大39 active personas と明示するよう置換した。
  • clients/typescript/README.md の冒頭を official POST /v1/reason OpenAPI 起点の説明へ揃え、パッケージ版 SSOT が src/po_core/__init__.py である旨と PO_SKIP_AUTH=false の場合は非空の API キーを渡すべき旨を追記した。
  • docs/status.mdCompleted / Next を更新して本 truth-sync の実施記録と今後の残件監査タスクを反映した。
  • ドキュメントのみの修正であり、golden(期待出力)や runtime/package のコードパスは変更していない。

Testing

  • 実行: pytest tests/test_release_readiness.py -v により該当リリース整合性テストが実行され、20 件すべてが合格(20 passed)。
  • 実行: cd clients/typescript && npm run build により TypeScript SDK のビルドが成功した。
  • 実行: cd clients/typescript && npm run test は最初にビルド順序のタイミングで失敗が出たが、ビルド後に再実行して SDK のテストは通過(ok - PoCoreClient.reason)。
  • 以上の自動化テストはすべて成功し、変更は docs-only であるため既存の golden 契約には影響を与えていない。

Codex Task

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant