docs(site): refresh reference documentation - #314
Merged
Conversation
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.
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
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.
docs/site の公開リファレンスを現行実装へ追従
Summary
docs/siteの CLI、API、設定、スキーマの公開リファレンスを現行のmainに合わせ、英語版と日本語版を同期しました。主な変更点:
tq api、tq config、実験的 TUI とビルドプロファイルの制約を追加tq issue cancelの遷移先をcancelledに訂正やったこと
tq configを追加ChangeRequestと状態遷移を追加tq updateの利用制約、TUI の読み取り専用表現を明確化動作確認
npm run build(英語・日本語の production build)git diff --checkレビュー & 動作確認 チェックリスト
tq api、TUI、tq config、tq updateの説明が実装と一致すること推奨テスト計画:
その他気になることや相談ごと
なし。