docs(repo): ADR-0004 の死んだリンクと README 依存表のずれを直す (#258 #257) - #262
Merged
Conversation
ADR-0004 の References が存在しないパス packages/verify/src/core/ VerificationEngine.ts を参照していた (ディレクトリごと無い)。verify 側の 現在の入口である verificationWorker.ts へ張り替え、PR #252 以降 shared の verifyProofFile へ委譲している旨を添えた。docs 配下 40 ファイルを走査して 相対リンク切れはこの 1 件のみで、週次の鮮度チェック (#261) が報告している のも同一の 1 件。 editor README の実行環境表が TypeScript のランタイムを「SWC」と書いていたが これは完全な誤記で、リポジトリに SWC は存在しない。実装は typescript パッケージの ts.transpileModule を直接呼んでいる。TS7 移行 (#208) の調査を 誤誘導するため、バージョン表記のずれより優先して直す。 依存表は dependabot が package.json だけを書き換えるため構造的にドリフト する。monaco-editor ^0.55 → ^0.56 (#206 で上がった分)、vite ^8.0 → ^8.1 を 実態に合わせ、欠落していた dompurify / marked の 2 行を追加。verify README にも同種の vite の桁ずれがあったので揃えた。 Closes #258 Closes #257 Assisted-by: Claude <noreply@anthropic.com>
github-actions
Bot
added
documentation
🚀 Preview Deployment
Deployed from commit 8fd1295 |
33 tasks
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
目的
2026-08 レビュー (#243) の残件のうち、docs の鮮度に関する低コスト指摘 2 件を解消する。
変更点
#258 — ADR-0004 が存在しないパスを参照している
docs/adr/0004-verifier-checkpoint-stance.mdの References がpackages/verify/src/core/VerificationEngine.tsを指していたが、このディレクトリごと存在しない。verify 側の現在の検証入口であるpackages/verify/src/workers/verificationWorker.tsへ張り替え、PR #252 以降 shared のverifyProofFileへ委譲している旨を添えた。POSW_ITERATIONS === 10000の必須検査 / isPureTyping 再計算 / 検証側にCHECKPOINT_INTERVALの hard-code 無し)。リンクだけが古いdocs/配下 40 ファイルを走査して相対リンク切れはこの 1 件のみ。週次の鮮度チェック (chore: 鮮度チェックの検知結果 (自動) #261) が報告しているのも同一の 1 件なので、次回実行から消える#257 — README の依存表が実態とずれている
packages/editor/README.md:SWCtypescript (ts.transpileModule)^0.55^0.56^8.0^8.1^8.1.5^3.4^18.0packages/verify/README.mdにも同種の vite の桁ずれ (^8.0→^8.1) があったので揃えた。両 README の他の行は package.json と一致していることを全行確認済み。「SWC」誤記を優先した理由: TS7 移行 (#208) を調べる人が実在しないビルドツールを探しに行くため、バージョン表記のずれより実害が大きい。
確認方法
npm run lint— greenpackages/{editor,verify}/package.jsonと突き合わせ済みpackages/verify/src/workers/verificationWorker.tsの実在を確認済み残課題 (本 PR の範囲外)
依存表のドリフトは dependabot が package.json だけを書き換える構造上、手作業同期では維持できない。
freshness.ymlに「README 依存表 vs package.json」の突合を足すのが根本対策だが、現状は表記規則 (patch を落とす / minor を落とす) がリポジトリ内でバラついており誤検知だらけになるため、規則の統一とあわせて別 Issue で扱う。Closes #258
Closes #257