Skip to content

docs(manual): update for eq + tot + MCP additions#97

Merged
k-yoshimi merged 1 commit into
developfrom
docs/manual-update-eq-tot-mcp
Apr 19, 2026
Merged

docs(manual): update for eq + tot + MCP additions#97
k-yoshimi merged 1 commit into
developfrom
docs/manual-update-eq-tot-mcp

Conversation

@k-yoshimi
Copy link
Copy Markdown
Owner

@k-yoshimi k-yoshimi commented Apr 19, 2026

Summary

2026-04-18 初版マニュアル (#73) の改訂. 完了モジュールが 5 個 (tr/ti/wr/wrx/fp) から 7 個 (+eq/tot) に拡大したのに合わせ, 新章 2 つを追加し既存章を最新化しました.

New chapters

Updated existing sections

  • 作業状況章: モジュール完了マトリクスを 7 行化 (tr/ti/wr/wrx/fp/eq/tot), eq F90 modernization (F-1..F-5) 完了マトリクス追加, MCP サーバ群 (tr/ti/wr/wrx/fp + tot 進行中 = 6 個) 追加
  • 残作業: trlib のみ実装の plot/TOML runner 横展開 (deferred), チュートリアル Notebook 集 (deferred) を追記
  • 付録 PR 一覧: 2026-04-18 → 2026-04-19, feat(tot): Phase L-6 4-layer tests #96 までを反映 (eq/tot/MCP すべて追記)
  • 付録最小例カタログ: eq / tot の最短コードを追加 (5 → 7 件)
  • タイトル / abstract / 編集後記: 5 → 7 モジュール, 2026-04-19 改訂明記

Page count delta

  • 旧版 PDF: 約 50 ページ (2026-04-18 初版)
  • 新版 PDF: 55 ページ (xelatex 2 回 pass で安定)
  • 増分: ~5 ページ (eq + tot 章は約 13 ページ追加, 状況/付録の更新で全体的に再フロー)

注: スペックは 60-100 ページを想定していましたが, eq/tot 章を簡潔に書いたため 55 ページに収まりました. 既存 5 章の構造に合わせた密度です. 必要なら次回改訂で hello-world をより冗長にし, F90 modernization 専用章を切り出す等で 60+ に拡張できます.

Verification

  • `xelatex -interaction=nonstopmode task-library-manual.tex` を 2 回 (実際は 3 回) 実行し exit 0
  • `grep -n "FIXME\|<<<<<<" docs/manual/task-library-manual.tex` → 0 hits
  • 既存 5 モジュール章 (tr/ti/wr/wrx/fp) は全文保持
  • ch:eq / ch:tot のクロスリファレンスは 2 nd pass で解決済み

Test plan

  • PDF を開いて目次に第 8 章 (eq) と第 9 章 (tot) が出ているか
  • eq 章の PSIB 0-origin と `set_param_str` の説明が正しいか
  • tot 章の namespace prefix 表に `wr:` 別名注記が入っているか
  • 完了マトリクスの 7 行が正しく出力されるか
  • 付録の PR 一覧で `feat(tot): Phase L-6 4-layer tests #96` までを参照できるか

Note

Low Risk
Documentation-only change, but it adds substantial new guidance around eq/tot APIs and status tables; risk is limited to potential inaccuracies/misalignment with the actual implementations.

Overview
Updates the Japanese TASK library manual to reflect expansion from 5 → 7 modules by adding new chapters for eq (MHD equilibrium) and tot (orchestrator), including build steps, minimal Python examples, parameter/ABI notes (e.g., eq_set_param_str, PSIB indexing), and test pointers.

Reworks existing overview/status content to match the new scope: updates title/abstract/date, table-of-contents structure, completion matrix, remaining-work items (notably tot fan-out still stubbed), MCP server coverage, Makefile targets, PR index, and the “minimal example catalog” to include eq/tot.

Reviewed by Cursor Bugbot for commit 0abc777. Bugbot is set up for automated code reviews on this repo. Configure here.

2026-04-19 改訂. tr/ti/wr/wrx/fp の 5 章はそのまま保持し,
新たに第 8 章 eq モジュール (6 関数 C ABI と PSIB 0-origin の
解説含む), 第 9 章 tot モジュール (名前空間プレフィックス設計)
を追加. 完了モジュールを 5 → 7 に拡大.

- 第 8 章 (eq): 概要, ビルド, hello-world, set_param_str (KNAMEQ),
  PSIB 0-origin / run() mode=1 デフォルトの FAQ, 約 60 件の
  パラメータ表, EqState フィールド, F90 modernization (F-1..F-5)
  への言及, 変更履歴 (PR #54/#65/#70/#78/#80/#86/#92/#89#71/#79/#81/#87/#93)
- 第 9 章 (tot): 概要, ビルド, hello-world, namespace prefix
  ディスパッチ表, wr→wrx 別名, dict/set_param_str, 既知制約
  (init/run/get_state/finalize は L-3/L-4/L-5 でスタブ),
  変更履歴 (PR #43/#82/#85/#91/#94)
- 状況章を更新: モジュール完了マトリクスを 7 行化,
  eq F90 modernization (F-1..F-5) 完了マトリクス追加,
  MCP サーバ群 (tr/ti/wr/wrx/fp + tot 進行中, 6 個) 追加
- 残作業: trlib のみ実装の plot/TOML runner 横展開 (deferred),
  チュートリアル Notebook 集 (deferred)
- 付録 PR 一覧を 2026-04-19 (#96 まで) に最新化, eq/tot/MCP 追記
- 補足カタログに eq/tot の最短例 2 つを追加
- xelatex 2 回コンパイル成功, PDF 55 ページ (旧版から +拡張)

Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
@k-yoshimi
Copy link
Copy Markdown
Owner Author

@cursor review

Copy link
Copy Markdown

@cursor cursor Bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

✅ Bugbot reviewed your changes and found no new issues!

Comment @cursor review or bugbot run to trigger another review on this PR

Reviewed by Cursor Bugbot for commit 0abc777. Configure here.

@k-yoshimi k-yoshimi merged commit 13d1564 into develop Apr 19, 2026
1 check passed
@k-yoshimi k-yoshimi deleted the docs/manual-update-eq-tot-mcp branch April 19, 2026 02:59
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