introduction/install/build guideの追加

close #11 (closed) #12 (closed) #13 (closed) #20 (closed)

概要

introduction / install_guide / build_guide の TBD だった記述の初版作成に加え、ドキュメント全体の構成を整理しました。インストール手順の整備、イントロダクションの再構成、実行ガイドの重複ページ整理、プリポスト案内の刷新が主な内容です。

主な変更

1. インストール・ビルドガイドの初版作成

  • install_guide/binary_install.ja.md:バイナリパッケージによるインストール手順を記述
  • install_guide/docker.ja.md:Docker イメージによる実行手順を記述
  • install_guide/index.ja.md:インストールガイドの入口を整備
  • 動作環境ページ(introduction/environment.ja.md)から GPU ビルドへ誘導

2. イントロダクションの再構成

  • introduction/about / features / environment を加筆・整理
  • 中身のない introduction/index を削除し、ナビ構成を整理
  • サイト(選択ガイド)と本体マニュアルの記述範囲を WRITING_POLICY で切り分け

3. プリポスト案内の刷新(prepost_tutorial 章 → イントロのルート選択ガイドへ集約)

  • 旧 prepost_tutorial/ 章(REVOCAP / FreeCAD / EasyISTR / Jupiter / ParaView / Advance Revocap の個別ページ)を削除
  • introduction/workflow_guide.ja.md の「ルートの選びかた」表に集約し、調査結果を反映
    • REVOCAP_PrePost を「公式配布の旧来GUI」と明記(同梱ソルバが旧版である旨を注記)
    • FreeCAD + FEM_FrontISTR の機能範囲を是正(活発に更新中)
    • EasyISTR を「UNVメッシュ取込の統合支援GUI」に修正し、配布元URLを移転先(opencae-dalab.org)へ更新
    • Jupiter / WELSIM の対応OS・商用を明記、PrePoSTR + PrePoMax を追加
    • Advance REVOCAP_PrePost は混同回避のため主表から注記へ移動
  • 表を「対応OS」「特徴」の列構成に簡潔化

4. 実行ガイド「概要」の重複ページ整理

  • 02_input(入力データの概略):キーワードリファレンス「入力規則」と重複のため削除
  • 05_constraint(実行時の制約):機能リファレンス「要素ライブラリ」と重複のため、未転記の制約を転記して削除
  • 03_output(出力ファイルの概略):ファイルの種類は「解析の流れ」へ、ログ・結果フォーマットは「出力・リスタート」へ溶かし込み削除
  • 04_execution_method(実行方法):「解析の流れ」(01_flow) へ統合し、1ページで実行方法が分かる構成に
  • 削除ページへの参照リンクを張り替え、ナビ翻訳(mkdocs.yml)を更新

5. コントリビューション章の削除

  • マニュアルサイトの contribution_guide/ は本体リポジトリの CONTRIBUTING へ誘導するだけの窓口だったため、章ごと削除

6. AI連携のページを追加

  • 今後AI連携関連の話題が増えたときに追記できるスペースとして作成。最初の事例でFabricaの記述を追加。

確認事項 / 残課題

  • 英語版 workflow_guide.en.md は title のみで本文は未整備(日本語が正本、fallback_to_default で表示)
  • mkdocs build --clean のリンク切れ WARNING は本MRの編集に起因する新規分なし(既存の theory / coding_guide 等のみ)
Edited by inagaki

Merge request reports

Loading
Loading