Skip to content

Link README Getting Started sections to docs site#262

Merged
version-1 merged 3 commits into
mainfrom
docs/link-getting-started
Jul 12, 2026
Merged

Link README Getting Started sections to docs site#262
version-1 merged 3 commits into
mainfrom
docs/link-getting-started

Conversation

@version-1

@version-1 version-1 commented Jul 12, 2026

Copy link
Copy Markdown
Owner

Link README Getting Started sections to the docs site

Summary

Keep the repository READMEs aligned with the published documentation site by linking the Getting Started headings and synchronizing the Problem section.

主な変更点:

  • Link the English README heading to https://version-1.github.io/tasq/.
  • Link the Japanese README heading to https://version-1.github.io/tasq/ja/.
  • Remove the duplicated Getting Started walkthrough so the section contains only the docs-site link.
  • Align the English README Problem section exactly with the docs-site overview.
  • Synchronize the Japanese Problem section with natural localized wording.

チケットへのリンク

ここはまだない

やったこと

  • Updated the English and Japanese README headings while keeping both documents synchronized.
  • Removed the local startup walkthrough from both READMEs in favor of the published documentation.
  • Added the Human Context Switching, Workspace Conflicts, and Repeated Setup Work subsections from the docs-site overview.

動作確認

  • git diff --check
  • Confirmed both headings contain the expected locale URL.
  • Confirmed the next section follows each link-only Getting Started heading directly.
  • Confirmed the English README and docs-site Problem sections match with diff.

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

  • English link - Confirm Getting Started opens the English docs-site overview.
  • Japanese link - Confirm Getting Started opens the Japanese docs-site overview.
  • Problem content - Confirm the README Problem statement matches the docs-site overview.

推奨テスト計画:

  1. Open each README on GitHub.
  2. Follow the Getting Started heading link.
  3. Confirm the expected docs locale opens.

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

特になし

Requested by: @version-1

Link the English and Japanese Getting Started headings to their corresponding published documentation site locales.\n\nVerified with git diff --check and exact heading URL checks.
Copy the English docs-site Problem section into the README and synchronize the Japanese README with natural localized wording.\n\nVerified the English sections with diff and ran git diff --check.
Remove the duplicated local startup walkthrough from the English and Japanese READMEs so Getting Started delegates to the published documentation site.\n\nVerified section boundaries and ran git diff --check.
@version-1 version-1 merged commit 8dc26d4 into main Jul 12, 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