Skip to content

docs: refresh READMEs — 5 tools, concise EN + 繁中 tutorial, full-width punctuation#65

Merged
shin13 merged 1 commit into
mainfrom
docs/readme-bilingual-refresh
Jul 23, 2026
Merged

docs: refresh READMEs — 5 tools, concise EN + 繁中 tutorial, full-width punctuation#65
shin13 merged 1 commit into
mainfrom
docs/readme-bilingual-refresh

Conversation

@shin13

@shin13 shin13 commented Jul 23, 2026

Copy link
Copy Markdown
Owner

Pre-v0.7.0 README review + refresh. Restructures both READMEs into differentiated bilingual docs: concise developer-facing English first, then a non-technical 繁體中文 section (not a mirror translation).

Fixes (wrong today, independent of the release)

  • Tool count 4 → 5. get_drug_appearance shipped in feat: get_drug_appearance tool (TFDA Dataset 42 drug appearance) #59, but the root README still said "4 tools / 4 個工具", and the subproject EN section said "four tools" while listing five.
  • Removed the stale "not yet on PyPI" caveatuvx taiwan-fda-mcp is live (v0.6.0).
  • Fixes the EN/繁中 drift that caused the count mismatch, by making the tutorial single-source (see below).

Structure

  • taiwan-fda-mcp/README.md — the technical + tutorial doc.
    • EN: concise 5-tool table, install, 3 client configs, one example, deployment, dev.
    • 繁中「完整教學」: step-by-step for non-programmers — install, Claude Desktop / Claude Code / Codex setup, 6 worked examples (dosage, 加框警語, drug appearance, ingredient 單方/複方, OTC, insert updates), a 未載明 explainer, and troubleshooting.
  • README.md (root) — the front door.
    • EN: tightened overview.
    • 繁中: friendly overview + a pointer to the subproject tutorial (single source of truth → no drift).

Conventions

  • 繁中 prose now uses full-width punctuation throughout (,。?!:;「」()) — the existing READMEs mixed in half-width commas.
  • Version strings deliberately left at v0.6.0; the v0.7.0 RELEASING.md flow bumps them so the README never claims a version not yet on PyPI.
  • docs/architecture.svg checked — it's a generic flow diagram (no hardcoded tool count), no change needed.

Docs-only; no code paths touched.

Assisted-By: Claude noreply@anthropic.com

… punctuation

Restructure both READMEs as differentiated bilingual docs: concise
developer-facing English first, then a non-technical 繁體中文 section.

- Fix tool count 4→5 (get_drug_appearance shipped in #59, but the EN count word
  and the root README still said four / 4 個工具; the EN subproject section even
  said "four tools" while listing five).
- Remove the stale "not yet on PyPI" caveat — `uvx taiwan-fda-mcp` is live (v0.6.0).
- taiwan-fda-mcp/README.md 繁中: complete step-by-step tutorial for non-programmers
  (install, 3 client configs, 6 worked examples incl. drug appearance, a 未載明
  explainer, and troubleshooting).
- Root README 繁中: trimmed to a friendly overview + a pointer to that tutorial —
  single source of truth, avoids the EN/繁中 drift this change fixes.
- 繁中 prose now uses full-width punctuation throughout.
- Version strings left at v0.6.0 (the v0.7.0 release flow bumps them).

Assisted-By: Claude <noreply@anthropic.com>
@shin13
shin13 merged commit 735c9ab into main Jul 23, 2026
2 checks passed
@shin13
shin13 deleted the docs/readme-bilingual-refresh branch July 23, 2026 09:40
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