リファレンス横断索引¶

この章は、docs/reference/ 配下に集めた CLI / CONFIG_DB / YANG の辞書ページと、Phase B で新設された機能章 (docs/topics/) との間を行き来するための索引である。機能章は読み物として運用導線を提供し、reference は辞書として「テーブル名」「コマンド名」「モジュール名」から逆引きできる。両者は別物だが、本来は両方向にリンクされていることが望ましい。

docs/reference/ 配下の現状は以下の通り (2026-05-11 時点)。最新の機械集計は reference/index.md のカバー率表を参照する (本ページの数字は読み物中の参考値)。

CLI ページ: 72 件 (config-* / show-* / debug-* / clear / reboot-fast-warm / sonic-* ツール)
CONFIG_DB ページ: 121 件 (table family ごと)
YANG ページ: 84 件 (sonic-* モジュールごと)
Runbooks: 45 件 (症状逆引き)
Verification: 1 件 (discrepancy-index)

この章では、これらを「機能章のどこから引かれるか」「逆に辞書からどの章へ戻るか」の対応表で並べ直す。既存 reference ページの本文と frontmatter は変更しない。

reference/index.md との分担¶

早見リンク集 (機能 → CLI / CONFIG_DB / YANG / Runbook の主要ページ) は reference/index.md が canonical。
章番号別の詳細表 (Phase B topics 章のどこから何が引かれるか) は本章の cli-index / config-db-index / yang-index が canonical。
統計 (カバー率 / verification 内訳) は reference/index.md が canonical。本章は数値を引用するのみ。

想定読み手の質問¶

CLI / CONFIG_DB / YANG の辞書ページは機能章からどう探すか。
既存の docs/reference/ は章本文に吸収するのか、独立した辞書として残すのか。
カテゴリページ (docs/categories/) と topics 章はどう役割分担するか。
discrepancy / reference gap はどこに置き、誰が消化していくのか。

読み進め方¶

概要: reference を辞書として残す設計と、章 / 辞書 / カテゴリの 3 層の関係。
CLI 横断索引: config-* / show-* / debug-* / ツール系を機能章ごとに並べた表。
CONFIG_DB 横断索引: table family を機能章ごとに並べ、逆引きを提供する。
YANG 横断索引: native SONiC YANG と OpenConfig / management framework との関係。
品質と gap: discrepancy ページと reference gap の追跡方法。
内部実装: reference ページの生成パイプライン (Indexer / gen_coverage / gen_cross_ref) と、frontmatter / verification status の運用を実装側から見る。

章構成と進捗¶

ページ	状態	verification
concept	✅ 完成 (107 行)	meta
setup	✅ 完成 (125 行)	meta
operations	✅ 完成 (113 行)	meta
internals	✅ 完成 (133 行)	meta
advanced	✅ 完成 (101 行)	meta

次に読むべき記事¶

この章を読み進める順

関連する HLD 7 件

関連トラブルシュート 5 件