87 lines
5.0 KiB
Markdown
87 lines
5.0 KiB
Markdown
# Directory Index（`docs/`）
|
||
|
||
面向 **LLM / 代理**：用**短描述**定位文件，避免通读全文。人读总目录仍以 **[INDEX.md](./INDEX.md)** 为准；**[index.md](./index.md)** 为 BMad 主索引。
|
||
|
||
**全项目怎么写、改**：先读 **[meta/DOCUMENTATION_STYLE.md](./meta/DOCUMENTATION_STYLE.md)**。
|
||
|
||
---
|
||
|
||
## `docs/` 根目录
|
||
|
||
| 文件 | 简述 |
|
||
|------|------|
|
||
| [INDEX.md](./INDEX.md) | 按主题分类的**完整链入表**（主入口之一） |
|
||
| [index.md](./index.md) | BMad Document Project 产出：AI 检索主索引 |
|
||
| [LLM_INDEX.md](./LLM_INDEX.md) | **本文件**：全目录轻量摘要（Index Docs） |
|
||
| [project-overview.md](./project-overview.md) | BMad 扫描：项目概览与分类 |
|
||
| [source-tree-analysis.md](./source-tree-analysis.md) | BMad 扫描：目录树与关键路径 |
|
||
| [development-guide.md](./development-guide.md) | 构建、验证脚本、文档维护约定 |
|
||
| [project-scan-report.json](./project-scan-report.json) | BMad 扫描状态元数据（JSON） |
|
||
| [WORK_PROGRESS.md](./WORK_PROGRESS.md) | 占位：指向 **meta/WORK_PROGRESS.md** |
|
||
| [Linux_HDMI_Audio_Roadmap.md](./Linux_HDMI_Audio_Roadmap.md) | 占位：指向 **linux-hdmi/** 路线图 |
|
||
|
||
---
|
||
|
||
## 仓库根 `_bmad-output/`（相对 `docs/` 为 `../_bmad-output/`）
|
||
|
||
| 文件 | 简述 |
|
||
|------|------|
|
||
| [../_bmad-output/planning-artifacts/prd.md](../_bmad-output/planning-artifacts/prd.md) | **PRD**：成功标准、旅程、**FR/NFR**（能力契约） |
|
||
| [../_bmad-output/project-context.md](../_bmad-output/project-context.md) | GPC：补丁、验证、文档入口约定 |
|
||
|
||
---
|
||
|
||
## `meta/`
|
||
|
||
| 文件 | 简述 |
|
||
|------|------|
|
||
| [DOCUMENTATION_STYLE.md](./meta/DOCUMENTATION_STYLE.md) | **体例宪章**：语言、入口、命名、术语、进度分工 |
|
||
| [DOCUMENTATION_ARCHITECTURE.md](./meta/DOCUMENTATION_ARCHITECTURE.md) | 文档入口分层、进度类分工、Mermaid |
|
||
| [WORK_PROGRESS.md](./meta/WORK_PROGRESS.md) | 换机交接、阶段结论、源码获取 |
|
||
| [CHROMEOS_vs_UBUNTU617_SOUND_AUTODIFF.md](./meta/CHROMEOS_vs_UBUNTU617_SOUND_AUTODIFF.md) | `sound/soc` 自动对照脚本结果摘要 |
|
||
| [OPERATION_DualBoot_Ubuntu24_Windows.md](./meta/OPERATION_DualBoot_Ubuntu24_Windows.md) | Ubuntu 24.04 与 Windows 双系统安装 |
|
||
|
||
---
|
||
|
||
## `linux-hdmi/`
|
||
|
||
| 文件 | 简述 |
|
||
|------|------|
|
||
| [Linux_HDMI_Audio_Roadmap.md](./linux-hdmi/Linux_HDMI_Audio_Roadmap.md) | Linux HDMI 无声：主路线图与成功标准 |
|
||
| [FIX_PLAN_HDMI_FROM_SOURCE_ANALYSIS.md](./linux-hdmi/FIX_PLAN_HDMI_FROM_SOURCE_ANALYSIS.md) | 基于源码对比的修复计划（阶段 A–D） |
|
||
| [REANALYSIS_Linux_HDMI_Audio_Kaisa.md](./linux-hdmi/REANALYSIS_Linux_HDMI_Audio_Kaisa.md) | 重分析：Mainline 误区、安装坑、优先级（现象表见路线图） |
|
||
| [PHASE_A_DEVICE_MAP_CHROMEOS_COLLECTED.md](./linux-hdmi/PHASE_A_DEVICE_MAP_CHROMEOS_COLLECTED.md) | 阶段 A：ChromeOS 采集与 ALSA 对应 |
|
||
| [CHROMEOS_KAISA_AUDIO_KERNEL_PATHS.md](./linux-hdmi/CHROMEOS_KAISA_AUDIO_KERNEL_PATHS.md) | ChromiumOS 5.15：HDMI 与 3.5mm 路径笔记 |
|
||
| [KERNEL_SRC_LINUX_HWE617_HDMI_3.5MM_PATHS.md](./linux-hdmi/KERNEL_SRC_LINUX_HWE617_HDMI_3.5MM_PATHS.md) | HWE 6.17 树：iDisp/rt5682/hda-dai 研读 |
|
||
| [SOURCE_DIFF_CHROMEOS515_UBUNTU617.md](./linux-hdmi/SOURCE_DIFF_CHROMEOS515_UBUNTU617.md) | ChromeOS 5.15 与 6.17 源码对比要点 |
|
||
| [CHROMEOS_VS_UBUNTU_HDMI_NOTES.md](./linux-hdmi/CHROMEOS_VS_UBUNTU_HDMI_NOTES.md) | HDMI/iDisp API 两系统对照 |
|
||
| [OPERATION_Kaisa_SOF_HDMI_Trace.md](./linux-hdmi/OPERATION_Kaisa_SOF_HDMI_Trace.md) | `STREAM_PCM_PARAMS` 与 IPC 载荷观测操作 |
|
||
| [SOF_FIRMWARE_TOPO_Kaisa_CHECKLIST.md](./linux-hdmi/SOF_FIRMWARE_TOPO_Kaisa_CHECKLIST.md) | SOF 固件与拓扑一致性核对清单 |
|
||
| [UPSTREAM_SOF_Kaisa_HDMI_REPRO.md](./linux-hdmi/UPSTREAM_SOF_Kaisa_HDMI_REPRO.md) | 上游复现材料与邮件模板 |
|
||
|
||
---
|
||
|
||
## `kernel-build/`
|
||
|
||
| 文件 | 简述 |
|
||
|------|------|
|
||
| [OPERATION_Install_CustomKernel_Ubuntu_HWE617.md](./kernel-build/OPERATION_Install_CustomKernel_Ubuntu_HWE617.md) | 装 deb（与 kernel-src README 分工：本文偏安装） |
|
||
| [OPERATION_ChromeOS_Kernel_Deep_Diff.md](./kernel-build/OPERATION_ChromeOS_Kernel_Deep_Diff.md) | unshallow / diff 主操作（AUTODIFF 仅统计） |
|
||
|
||
---
|
||
|
||
## `windows/`
|
||
|
||
| 文件 | 简述 |
|
||
|------|------|
|
||
| [OPERATION_Windows_Audio.md](./windows/OPERATION_Windows_Audio.md) | CoolStar 顺序与排障（概况表见根 README） |
|
||
| [HARDWARE_ID_DRIVER_MAP_Windows.md](./windows/HARDWARE_ID_DRIVER_MAP_Windows.md) | Hardware ID → 驱动包（与 OPERATION 分工） |
|
||
|
||
---
|
||
|
||
## 使用建议
|
||
|
||
1. **任务**：Linux HDMI → 优先 **linux-hdmi/Linux_HDMI_Audio_Roadmap** + **FIX_PLAN**；换机状态 → **meta/WORK_PROGRESS**。
|
||
2. **补丁/编译**：仓库 **[patches/README](../patches/ubuntu-hwe-6.17/README.md)**、**[kernel-src/README](../kernel-src/README.md)**（在 `docs/` 外，见 **[REPO_INDEX.md](../REPO_INDEX.md)**）。
|
||
3. 更新本索引：在 `docs/` 下**新增/删除**主题文档后，重跑 **`[ID] Index Docs`** 或手工增删一行。
|