Skip to content

Tabulate documentation map#266

Merged
version-1 merged 2 commits into
mainfrom
docs/tabulate-documentation-map
Jul 12, 2026
Merged

Tabulate documentation map#266
version-1 merged 2 commits into
mainfrom
docs/tabulate-documentation-map

Conversation

@version-1

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

Copy link
Copy Markdown
Owner

Tabulate the documentation map

Summary

Make the Overview documentation map easier to scan by presenting it as a table and add the Agent Tutorial entry.

主な変更点:

  • Replace the prose documentation map with a six-row table.
  • Add Agent Tutorial to the English overview.
  • Synchronize the Japanese overview with localized table descriptions.
  • Point both README Documentation sections to the published documentation site.
  • Remove the duplicated README Development sections.

チケットへのリンク

ここはまだない

やったこと

  • Added the Agent Tutorial path at /getting-started/agent-tutorial.
  • Described when to use QuickStart, Agent Tutorial, Setup Guide, Concepts, Guides, and Reference.
  • Simplified the English and Japanese README documentation entry points to their locale-specific sites.

動作確認

  • npm --prefix docs/site run build
  • git diff --check
  • Confirmed the Agent Tutorial entry and both table headers are present.
  • Confirmed the README Documentation sections link to the expected locale sites and no Development heading remains.

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

  • English map - Confirm all six entries render as a table on the overview page.
  • Japanese map - Confirm the localized table renders with the same links.
  • Agent Tutorial - Confirm the new entry opens /getting-started/agent-tutorial.
  • README documentation - Confirm both README Documentation links open the expected site locale.

推奨テスト計画:

  1. Open the English and Japanese Overview pages.
  2. Confirm the documentation map is a table.
  3. Follow the Agent Tutorial link in each locale.

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

特になし

Requested by: @version-1

Replace the overview documentation map prose with a concise table and add the Agent Tutorial entry in English and Japanese.\n\nVerified with npm --prefix docs/site run build and git diff --check.
Point the Documentation sections to the published docs site and remove the duplicated Development sections in English and Japanese.\n\nVerified with git diff --check and README section checks.
@version-1 version-1 merged commit ad12915 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