キーワードリファレンスの構造整備・見出しレベル統一・CIスタイルチェック導入

inagakirequested to merge
inagaki.kazuhisa/frontistr_documents:kinagaki/restructure-keyword-reference into main

Close #7 (closed)

キーワードリファレンスの構造を体系的に整備し、ドキュメントの構造化・国際化・品質管理を改善する。できるサイトはパイプラインの生成物を確認ください（プライバシーエラーがでますが…）

サンプルページ

変更内容

1. キーワードリファレンスの構造整備 (527d063)

  • 全キーワードカードファイル（cnt/msh/dat/part）にYAML frontmatter（title）を追加
  • 各セクションにindex.{ja,en}.mdを追加し、ナビゲーション構造を明確化
  • 共通のinput_rules.{ja,en}.mdページを追加
  • .pagesファイルで日本語ナビタイトルを設定、mkdocs.ymlにnav_translationsを追加

2. キーワードリファレンス以外のセクション整備 (231bd07)

  • 各セクション（examples, execution_guide, theory等）のファイルをナンバリング付きにリネーム
  • frontmatter追加・見出しレベル修正を全セクションに適用
  • .pagesファイル追加によるナビゲーション整備
  • CONTRIBUTING.mdを新規追加

3. CIスタイルチェックの導入 (00008bb)

  • .gitlab-ci.ymlにstyle-checkステージとジョブを追加
  • tools/check_style.pyでfrontmatter有無・ファイル命名規則を自動検証

4. 英語ファイルの見出しレベル統一 (16eb910)

  • 英語キーワードカード・理論セクションの見出しを ### → ## に統一
  • check_style.pyのファイル名バリデーションとfrontmatterパースを改善

5. mkdocs.yml設定修正 (2154e74)

  • awesome-pages/excludeプラグインの順序をi18nより前に移動
  • 言語切替用のalternate設定を追加

影響範囲

  • 340ファイル変更、約3600行追加・1200行削除
  • キーワードリファレンス全体の見出しレベル変更
  • CIパイプラインにstyle-checkジョブ追加
  • mkdocsビルド・ナビゲーション生成に影響

Merge request reports