Skip to content

docs(site): refresh reference documentation - #314

Merged
version-1 merged 2 commits into
mainfrom
worktrees/2/docs/review-site-references
Aug 14, 2026
Merged

docs(site): refresh reference documentation#314
version-1 merged 2 commits into
mainfrom
worktrees/2/docs/review-site-references

Conversation

@version-1

Copy link
Copy Markdown
Owner

docs/site の公開リファレンスを現行実装へ追従

Summary

docs/site の CLI、API、設定、スキーマの公開リファレンスを現行の main に合わせ、英語版と日本語版を同期しました。

主な変更点:

  • tq apitq config、実験的 TUI とビルドプロファイルの制約を追加
  • change request の API、スキーマ、状態遷移、一覧条件を追加
  • tq issue cancel の遷移先を cancelled に訂正
  • 日本語版の直訳調表現を改善し、英語版との意味を同期

やったこと

  • CLI リファレンスを現行コマンドと実装上の制約に合わせて更新
  • Issue Tracker API の change request エンドポイントと OpenAPI への導線を追加
  • 設定リファレンスへビルドプロファイルと tq config を追加
  • スキーマリファレンスへ ChangeRequest と状態遷移を追加
  • Reviewer の指摘を受け、本文編集条件、一覧取得条件、tq update の利用制約、TUI の読み取り専用表現を明確化

動作確認

  • npm run build(英語・日本語の production build)
  • git diff --check
  • Reviewer による実装、OpenAPI、一次リファレンスとの再照合

レビュー & 動作確認 チェックリスト

  • 英日同期 - 4つのリファレンスで契約と制約が同じ意味になっていること
  • CLI 契約 - tq api、TUI、tq configtq update の説明が実装と一致すること
  • ChangeRequest 契約 - API、スキーマ、状態遷移、一覧条件が OpenAPI と一致すること

推奨テスト計画:

  1. Docusaurus の英語版と日本語版を production build する
  2. CLI と API の表を実装・OpenAPI と照合する
  3. change request の状態遷移と本文編集条件を英日両方で確認する

その他気になることや相談ごと

なし。

Synchronize the English and Japanese CLI, API, configuration, and schema references with the current implementation. Document raw API access, terminal UI and config commands, change requests, and build-profile behavior.\n\nVerified with the Docusaurus production build for both locales and git diff --check.
Document change-request editing and list limits, profile restrictions for tq update, and the read-only TUI contract.\n\nAddresses PR review findings and keeps the English and Japanese references synchronized. Verified with the Docusaurus production build for both locales and git diff --check.
@version-1
version-1 merged commit a2a384e into main Aug 14, 2026
5 checks passed
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