Skip to content

docs: add RuntimeHost README and shared appsettings guide#20

Open
ssaattww wants to merge 10 commits into
mainfrom
docs/runtimehost-readme-appsettings
Open

docs: add RuntimeHost README and shared appsettings guide#20
ssaattww wants to merge 10 commits into
mainfrom
docs/runtimehost-readme-appsettings

Conversation

@ssaattww
Copy link
Copy Markdown
Member

@ssaattww ssaattww commented May 16, 2026

Summary

  • add RuntimeHost / DebugHost README updates and shared Tracker appsettings guidance
  • add repository Markdown lint wiring for textlint, cspell, strict whitelist checks, and prh notation rules
  • add SudachiPy-based vocabulary extraction and switch whitelist checking to the SudachiPy-backed shared script
  • keep report artifacts for review evidence and update Tracker/Design progress records

Validation

  • npm run lint:md:text
  • node .agents/skills/review-enforcer/scripts/list-markdown-targets.js --files tools/lint/README.md --print0 | xargs -0 -r node .agents/skills/review-enforcer/scripts/run-cspell-markdown.js
  • PATH="$PWD/.codex-doc-lint-venv/bin:$PATH" npm run lint:md:vocab -- --files tools/lint/README.md
  • PATH="$PWD/.codex-doc-lint-venv/bin:$PATH" printf 'SudachiPy\n' | PATH="$PWD/.codex-doc-lint-venv/bin:$PATH" npm run lint:md:whitelist -- --stdin tools/lint/README.md --list-unknown
  • git diff --check
  • DOC-LINT-002 review: reports/doc-lint-002-review-r2-20260517104319.md, no findings

Notes

  • Depends on CodexSkill PR Add SudachiPy Markdown vocabulary scripts ssaattww/CodexSkill#38 for shared SudachiPy scripts.
  • npm run lint:md:whitelist and full npm run lint:md intentionally fail until the whitelist is rebuilt from the new vocabulary inventory, because SudachiPy now detects Japanese noun tokens in prose and whitelist descriptions.
  • tools/lint/markdown-whitelist.yaml changes in this PR are limited to user-reviewed minimal terms: Markdown, リンク, SudachiPy, Python, and JavaScript.
  • AGENTS.md remains gitignored and was not force-added.

ssaattww added 10 commits May 16, 2026 21:29
## 背景
- Markdown 用語検査で、ホワイトリスト定義自体も単体確認できる状態が必要だった
- alias に別概念が混ざっており、許可語の意味範囲が広がっていた

## 変更内容
- tools/lint/markdown-whitelist.yaml の alias を表記揺れに寄せ、別概念は個別 term に分離した
- スナップショットを一般表記として追加し、render snapshot などの複合語は英語複合語として維持した
- 既存の一時許可語一覧を削除し、承認済みの複合語登録へ置き換えた

## 検証
- node .agents/skills/review-enforcer/scripts/check-markdown-whitelist.js --stdin tools/lint/markdown-whitelist.yaml --list-unknown < tools/lint/markdown-whitelist.yaml
- node .agents/skills/review-enforcer/scripts/run-cspell-markdown.js tools/lint/markdown-whitelist.yaml
- git diff --check -- tools/lint/markdown-whitelist.yaml
## 背景
- report 以外の Markdown lint 対象文書について、英単語混在とホワイトリスト候補の整理を進めていた
- gpt-5.5 high の分担作業結果と提案 report が未 commit のまま残っていたため、作業ツリーを clean にする必要があった

## 変更内容
- Tracker/Design 配下の設計文書で、日本語化できる語を整理した
- Tracker/Design/tasks-status.md に Markdown lint 作業の進捗を反映した
- doc-lint 関連の調査、分担作業、ホワイトリスト提案 report を reports/ に追加した

## 検証
- git diff --cached --check
- node .agents/skills/review-enforcer/scripts/list-markdown-targets.js --changed --print0 | xargs -0 -r ./node_modules/.bin/textlint --config .textlintrc.json --rulesdir .agents/skills/review-enforcer/scripts/textlint-rules
- node .agents/skills/review-enforcer/scripts/list-markdown-targets.js --changed --print0 | xargs -0 -r node .agents/skills/review-enforcer/scripts/run-cspell-markdown.js は未整理語が残って失敗
- npm run lint:md:whitelist -- --changed --list-unknown は未整理語が残って失敗
## 背景
- 無理に日本語化した設計書と README はいったん立ち戻り、先に lint の仕組み側を作り込む方針になった
- ホワイトリストや lint 仕組みは再利用するため、この commit では本文資料だけを対象にする

## 変更内容
- Tracker/Design 配下の本文設計書を f5482ab 時点へ戻した
- README.md、Tracker.CaptureReplay、Tracker.DebugHost の README を同じ時点へ戻した
- f5482ab 時点に存在しなかった Tracker/README.appsettings.md と Tracker.RuntimeHost README を削除した

## 検証
- git diff --cached --exit-code f5482ab -- README.md Tracker/README.appsettings.md Tracker/Tracker.CaptureReplay/README.md Tracker/Tracker.DebugHost/README.md Tracker/Tracker.RuntimeHost/README.md Tracker/Design/Core/tracker-architecture-plan.md Tracker/Design/Core/tracker-core-engine-detail-design.md Tracker/Design/Core/tracker-history-000-038.md Tracker/Design/Core/tracker-test-maintainability-detail-design.md Tracker/Design/DebugHost/debug-host-cli-ui-detail-design.md Tracker/Design/DebugHost/debug-host-maintainability-design.md Tracker/Design/DebugHost/raw-vision-viewer-plan.md Tracker/Design/RuntimeHost/runtime-host-plan.md
- git diff --cached --check
@ssaattww
Copy link
Copy Markdown
Member Author

ChikkarPy 対応を追加しました。

  • tools/lint/requirements.txtchikkarpy==0.1.1 と build helper を追加
  • tools/lint/README.mdPIP_NO_BUILD_ISOLATION=1 を使うセットアップ手順を追記
  • npm run lint:md:vocab が ChikkarPy の同義語候補を出力する前提を記録
  • --synonyms none で ChikkarPy なしの抽出に戻せることも記録

検証:

  • PIP_NO_BUILD_ISOLATION=1 .codex-doc-lint-venv/bin/python -m pip install -r tools/lint/requirements.txt
  • . .codex-doc-lint-venv/bin/activate && npm --silent run lint:md:vocab -- --files tools/lint/README.md --format json

共有スクリプト側の PR: ssaattww/CodexSkill#39

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