Skip to content

docs: align all documentation with redesigned examples#176

Merged
yeongseon merged 3 commits intomainfrom
docs/align-with-redesigned-examples
Apr 12, 2026
Merged

docs: align all documentation with redesigned examples#176
yeongseon merged 3 commits intomainfrom
docs/align-with-redesigned-examples

Conversation

@yeongseon
Copy link
Copy Markdown
Owner

Summary

Closes #175

All documentation now references the new examples introduced in PR #174. No code or test changes — documentation only.

Changes

  • 4 new example doc pages: webhook_receiver.md, report_jobs.md, notification_request.md, partner_import_bridge.md
  • 4 old example doc pages deleted: hello.md, todo_crud.md, with_validation.md, with_bridge.md
  • deployment.md rewritten: Example 1 → report_jobs (Bearer auth, job submission/polling/download), Example 2 → notification_request (validation integration)
  • All cross-references updated: READMEs (en/ko/ja/zh-CN), mkdocs.yml, index.md, getting-started.md, usage.md, faq.md, testing.md, contributing.md, PRD.md, demo/README.md

Verification

  • make test — 369 passed, 92.99% coverage
  • make lint — no issues
  • make typecheck — no issues
  • make build — success
  • grep scan for stale references — clean (only CHANGELOG.md historical entries remain, intentionally)

Update all documentation references from old examples (hello, todo_crud,
with_validation, with_bridge) to new examples (webhook_receiver,
report_jobs, notification_request, partner_import_bridge).

- Replace 4 example doc pages with new comprehensive guides
- Rewrite deployment.md with report_jobs and notification_request
- Update READMEs (en, ko, ja, zh-CN), mkdocs.yml, index.md
- Update getting-started, usage, faq, testing, contributing, PRD
- Fix demo/README.md reference

Closes #175
@yeongseon yeongseon merged commit 015f5dd into main Apr 12, 2026
12 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.

docs: align all documentation with redesigned examples

1 participant