Skip to content

docs: Diátaxis 構造でドキュメントを整備する (#43)#47

Merged
hideyukiMORI merged 1 commit into
mainfrom
docs/issue-43-diataxis
May 19, 2026
Merged

docs: Diátaxis 構造でドキュメントを整備する (#43)#47
hideyukiMORI merged 1 commit into
mainfrom
docs/issue-43-diataxis

Conversation

@hideyukiMORI
Copy link
Copy Markdown
Owner

Summary

  • docs/index.md — Diátaxis ナビゲーションハブを新設
  • docs/tutorials/ — 2 チュートリアル(はじめての nene2-python / 新ドメイン実装)
  • docs/how-to/ — 3 実践ガイド(新ドメイン追加 / 認証設定 / テスト実行)
  • docs/explanation/ — アーキテクチャ概要 + 設計思想と PHP NENE2 対応表
  • docs/reference/ — 設定リファレンス(環境変数全覧) + フレームワークモジュール + REST API リファレンス

既存の docs/adr/, docs/howto/, docs/roadmap.md はそのまま維持し、docs/index.md からリンク。

Test plan

  • uv run pytest — 144 passed, coverage 91%(コード変更なし)
  • ドキュメント相互リンクの整合性を目視確認

Closes #43

🤖 Generated with Claude Code

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
@hideyukiMORI hideyukiMORI merged commit 2573e8d into main May 19, 2026
1 check failed
@hideyukiMORI hideyukiMORI deleted the docs/issue-43-diataxis branch May 19, 2026 12:15
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.

docs: Diátaxis 構造でドキュメントを整備する

1 participant