ドキュメント構成の整理: コンテンツ追加・セクション番号整理・ビジュアライザキーワードの再配置

inagakirequested to merge
inagaki.kazuhisa/frontistr_documents:kinagaki/restructure-policy-and-style-guides into main

Close #10 (closed)

表示

ドキュメントの構成整理として、以下の変更を行いました。

1. ポリシー・スタイルガイドの整備

  • CONTRIBUTING.mdを拡充し、コントリビューション手順を詳細化
  • WRITING_POLICY.mdを新規追加し、ドキュメント執筆規約を明文化

2. 日本語コンテンツの追加

  • introduction、install guide、build guide、execution guide、prepost tutorialセクションに日本語ドキュメントを追加
  • ただし、記載予定の内容をコメントに記述したのみで本文はTBD、英語版はスタブファイルのみ設定

3. functions_referenceの拡充と番号整理

  • 解析タイプ、境界条件/荷重、接触、ソルバー、要素活性化、出力/リスタート、エラーメッセージのページを新規追加
  • ファイル番号を論理的順序に整理（element 01→02、material 02→03、partition 03→10、step 04→07）
  • 番号変更に伴う重複ファイルを削除
  • .pagesナビゲーションを追加

4. 理論ドキュメントの追加と再構成

  • 連続体力学、FEM離散化、要素ライブラリ、材料モデル、接触、並列FEM、ソルバーの理論ドキュメントを新規追加
  • 解析手法（静的非線形、動的、固有値、周波数応答、熱）をtheory/analysis/サブディレクトリに移動・整理
  • インデックスページと.pagesナビゲーションを追加

5. ビジュアライザキーワードの再配置

  • ビジュアライザ専用CNTキーワード（ambient_coef、color_comp_name等）をcnt/visualization/サブディレクトリに移動
  • タイトルを小文字に統一

6. リンク修正・ツール更新

  • ファイル移動に伴う壊れたクロスリファレンスリンクを修正
  • check_style.py: メタコメントチェックと画像パス検証を追加
  • mkdocs.yml: nav_translationsとV&Vテーブルフォーマットを更新
  • .gitignore: Pythonバイトコードとキャッシュディレクトリのルールを追加

Merge request reports