Skip to content

docs: add bilingual site map pages and embed them in READMEs#127

Merged
singyichen merged 3 commits into
mainfrom
docs/site-map
Jul 22, 2026
Merged

docs: add bilingual site map pages and embed them in READMEs#127
singyichen merged 3 commits into
mainfrom
docs/site-map

Conversation

@singyichen

Copy link
Copy Markdown
Owner

Purpose

Add a spec-derived site map (Traditional Chinese + English) under docs/site-map/ and surface it in both READMEs so visitors can grasp the full page structure at a glance.

Reason

The 17 feature specs define 13 pages across 7 sidebar navigation areas, but there was no single visitor-facing overview of the site structure. GitHub does not render repo HTML inside READMEs, so each map is embedded as a PNG snapshot with a link to the standalone interactive HTML version.

Result

Deliverable Description
Tree-diagram site map Root → 7 nav areas (sidebar order per shared-008) → 13 pages → sub-tabs/steps, with access-level badges (Public / Sign-in / Task role / Admin)
Bilingual versions site-map.zh-TW.html (fully Traditional Chinese) and site-map.en.html (fully English); self-contained, fixed light theme, Label Suite design tokens
README integration README.md gets a "Site Map" section (English PNG); README.zh-TW.md gets the Traditional Chinese counterpart; both link to the HTML versions

Changed Files

File Change
docs/site-map/site-map.zh-TW.html New — standalone Traditional Chinese site map page
docs/site-map/site-map.zh-TW.png New — full-page Playwright snapshot (1440px)
docs/site-map/site-map.en.html New — standalone English site map page
docs/site-map/site-map.en.png New — full-page Playwright snapshot (1440px)
README.md New "Site Map" section embedding the English PNG + HTML link
README.zh-TW.md New「網站地圖」section embedding the zh-TW PNG + HTML link

Test Plan

  • Both HTML pages render correctly (verified via Playwright full-page screenshots at 1440px)
  • README image and HTML link paths resolve to files that exist in the repo
  • English page contains no residual Chinese text (script-verified); Chinese page contains no English UI labels
  • Page content cross-checked against the 17 feature specs and shared-008 sidebar nav order
  • No production code touched — backend/frontend/prototype test suites not applicable (docs-only change)

Notes

  • Touches 6 files (guardrail is 5): the bilingual HTML+PNG pairs and the two READMEs form one inseparable docs purpose; splitting further would leave broken README references.
  • PNGs are static snapshots — regenerate with npx playwright screenshot --full-page --viewport-size=1440,900 <file-url> <out.png> (from design/prototype/) whenever the site map HTML changes.
  • Site map reflects specs as of specs/STATUS.md 2026-07-22; the deferred Help button (shared-018) is intentionally excluded.

Impact Scope

  • Frontend
  • Admin
  • API
  • Queue
  • Other: documentation only (READMEs + docs/site-map/)

Related

None

🤖 Generated with Claude Code

singyichen and others added 3 commits July 22, 2026 20:57
- **Add** docs/site-map/site-map.zh-TW.html — standalone tree-diagram site map compiled from the 17 feature specs (7 nav areas, 13 pages, sub-tabs/steps, access-level badges), styled with the Label Suite design tokens, fixed light theme, self-contained (no external assets)
- **Add** docs/site-map/site-map.zh-TW.png — full-page Playwright snapshot (1440px) for README embedding, since GitHub does not render repo HTML in READMEs

Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
- **Add** docs/site-map/site-map.en.html — English counterpart of the site map tree diagram, fully translated (section names, pages, sub-tabs, access badges, hover descriptions) with English line-height 1.6
- **Add** docs/site-map/site-map.en.png — full-page Playwright snapshot (1440px) for README embedding

Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
- **Embed** the English site map PNG in README.md as a new "Site Map" section after System Workflow, linking to the standalone HTML version
- **Embed** the Traditional Chinese site map PNG in README.zh-TW.md after the motivation section, linking to its standalone HTML version

Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
@singyichen singyichen added the docs 文件需求/修正 — Documentation additions or fixes label Jul 22, 2026
@gemini-code-assist

Copy link
Copy Markdown

Caution

The consumer version of Gemini Code Assist on GitHub has been sunset. All code review activity has officially ceased.

@qodo-code-review

Copy link
Copy Markdown

Qodo reviews are paused for this user.

Troubleshooting steps vary by plan Learn more →

On a Teams plan?
Reviews resume once this user has a paid seat and their Git account is linked in Qodo.
Link Git account →

Using GitHub Enterprise Server, GitLab Self-Managed, or Bitbucket Data Center?
These require an Enterprise plan - Contact us
Contact us →

@amazon-q-developer amazon-q-developer Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This documentation PR adds bilingual site map pages with clean implementation. The HTML files are well-structured with proper accessibility attributes, consistent design tokens, and self-contained styling. Both README updates correctly reference the new assets. No blocking issues found—ready for merge.


You can now have the agent implement changes and create commits directly on your pull request's source branch. Simply comment with /q followed by your request in natural language to ask the agent to make changes.

@singyichen
singyichen merged commit 63bb225 into main Jul 22, 2026
10 checks passed
@singyichen
singyichen deleted the docs/site-map branch July 22, 2026 13:29
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

docs 文件需求/修正 — Documentation additions or fixes

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant