questix_documentation

QUESTiX ロボットの インストール / ハードウェア / 回路 ドキュメントです。 MkDocs Material で構築し、GitHub Pages で公開しています。

公開サイト

https://scramble-robot.github.io/questix_documentation/

ローカルでのプレビュー

# 仮想環境（任意）
python3 -m venv .venv
source .venv/bin/activate

# 依存パッケージのインストール
pip install -r requirements.txt

# ローカルサーバーを起動（http://127.0.0.1:8000）
mkdocs serve

ビルド

mkdocs build --strict

site/ ディレクトリに静的サイトが生成されます。

デプロイ

main ブランチへ push すると、GitHub Actions（.github/workflows/deploy.yml）が 自動でビルドし GitHub Pages へ公開します。

初回のみ、リポジトリの Settings → Pages → Build and deployment → Source を GitHub Actions に設定してください。

ディレクトリ構成

.
├── mkdocs.yml              # サイト設定・ナビゲーション
├── requirements.txt        # ビルドに必要な Python パッケージ
├── .github/workflows/      # GitHub Pages デプロイ用ワークフロー
└── docs/
    ├── index.md            # トップページ
    ├── installation/       # インストール手順
    ├── hardware/           # ハードウェア仕様
    ├── circuit/            # 回路・配線・通信プロトコル
    └── software/           # ROS2 パッケージ・launch 補足