Skip to content

docs(workspace): update docs for certified devices data source - #271

Merged
gurezo merged 4 commits into
mainfrom
docs/issue-262-update-certified-devices-docs
Sep 12, 2026
Merged

gurezo merged 4 commits into
mainfrom
docs/issue-262-update-certified-devices-docs

Conversation

@gurezo

@gurezo gurezo commented Sep 12, 2026 •

Copy link
Copy Markdown
Owner

PR タイトルは Conventional Commits に準拠してください (例: feat(web): add device list component)。
利用可能な scope は CONTRIBUTING.md と commitlint.config.js を参照してください。

Summary

Certified Devices JSON を唯一のデータソースとする新構成に合わせて、README / architecture / データ更新ドキュメントを更新しました。Dashboard 側の同期・生成手順と、削除済み script / workflow への参照を除去しています。

Type of change

  • Bug fix
  • New feature
  • Refactor
  • Documentation
  • Chore (build/test/ci)
  • Breaking change

Related issues

What changed?

  • README のデータソースを chirimen-certified-devices/generated/devices.json に更新し、ローカル生成コマンドと削除済み tools README へのリンクを除去した
  • architecture から tools / data generation layer を外し、Certified Devices JSON → data-access → adapter → state → UI の構成図と責務分離を追加した
  • デバイス情報更新手順を全面書き換えし、修正先を chirimen-certified-devices、UI 不具合は本リポジトリと区別した
  • 開発ドキュメントから旧データ生成コマンドを削除し、packageManager 表記を pnpm@11.24.0 に合わせた

API / Compatibility

  • Public API changes (export / function signature / behavior)
    • Details:
  • This change is backward compatible
  • This change introduces a breaking change
    • Migration notes:

How to test

  1. README / docs/architecture.md / docs/device-data-refresh.md / docs/development.md の相対リンクが実在ファイルを指すことを確認する
  2. sync:example-upstreams / generate:devices / refresh-devices / apps/web/public/devices.json / tools/scripts の案内がドキュメントに残っていないことを確認する
  3. GitHub 上で Mermaid 図が読めることを確認する

Environment (if relevant)

  • Browser:
  • OS: macOS / Windows / Linux
  • Node version:
  • pnpm version:

Checklist

  • I ran tests locally (if available)
  • I updated docs/README if needed
  • I considered error handling where relevant

gurezo and others added 4 commits September 12, 2026 18:14
Co-authored-by: Cursor <cursoragent@cursor.com>
Co-authored-by: Cursor <cursoragent@cursor.com>
Co-authored-by: Cursor <cursoragent@cursor.com>
Co-authored-by: Cursor <cursoragent@cursor.com>
@gurezo
gurezo merged commit cbd24cd into main Sep 12, 2026
2 checks passed
@gurezo
gurezo deleted the docs/issue-262-update-certified-devices-docs branch September 12, 2026 14:50
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.

[Feature]: README / architecture / データ更新ドキュメントを更新する

1 participant