Skip to content

文档 IA 重组:/dev 四组化 + 生成参考 + llms.txt(对齐 DSH) #26

Closed

Description

@DoodleBears

Why

BotHarness 的产品规范、目标架构、当前实现契约与历史决策目前混排在 /dev 下。页面可读,但导航、AI discovery surface 与“设计态 / 已实现”边界不够清楚:llms.txt 是平铺列表,每页原始 Markdown 只有 index.md 形式,也缺少由当前代码生成的实现参考。

本 issue 以当前架构(#71、ADR-0035–0045、living architecture)为准完成文档 IA 收口,不再机械复制 2026-09-18 research 中已经过时的假设。

Scope

  • 保留三根:/docs(用户文档)、/dev(BotHarness 产品与工程)、/changelog。
  • 将 /dev 明确为四组:
    1. Design:规范术语、平台规格、PRD、living architecture 与 focused runtime architecture;
    2. Guides:面向实现者的操作指南;
    3. Reference:从当前代码生成、只描述已经存在的 config / tools / public events;
    4. Decisions:ADR index 与逐条 ADR。
  • 新增真正的 /dev landing page,说明 Design 是规范性目标,Reference 是当前实现事实;未实现的目标架构不得出现在 generated reference 中。
  • 新增 /dev/reference/{config,tools,events}:
    • Config 从 core 的 Config / defaults 生成;
    • tools 从实际 defineTool 注册生成;
    • events 只列实际公开的 Cordis event 接线。内部 BotStateEvent 不作为公共事件契约;如果当前没有公共事件,页面必须明确显示 none。
  • 为 ADR 提供 index;旧 /dev/architecture/**、/dev/spec/** URL 做永久迁移,不留下重复 authority。
  • 为每页提供无尾斜杠的 .md sibling,并保留现有 index.md 兼容面;/dev/llms.txt 按四组输出。
  • 英文根与 /zh/** 镜像;中文页面必须有对应正文或明确的 untranslated 状态,不引入版本选择器。
  • 更新仓库内文档链接、AGENTS 指针与 docs sync/build checks;不手改 generated content。

Non-goals

  • 不把 /dsh 的 DSH/Cordis Context 与 Decision Tree 混回 BotHarness 产品文档。
  • 不把 research 中的社区/API 快照提升为稳定 Skill 或 Reference。
  • 不为尚未实现的 Inbox / Orchestrator / Work APIs 伪造当前代码参考。
  • 不在本 issue 补齐所有未来用户指南内容。

Acceptance criteria

  • /dev 有四组清晰入口,Design 与 current implementation reference 的语义边界明确。
  • Config、tools、public events reference 从源码生成并有漂移检查;不存在的公共事件不会被臆造。
  • ADR index 可浏览,长 ADR 列表不再占满 /dev 首页。
  • /dev/llms.txt 按 Design / Guides / Reference / Decisions 分组。
  • 每个 /dev 页面都有 /<page>.md;原 /<page>/index.md 保持兼容。
  • 英文和中文路由、旧 URL redirects、站内链接、agent surfaces 均通过构建验证。
  • lint、format、typecheck、tests 与 docs build 全部通过,并部署生产文档站。

Dependencies

Delivered

Activity

  1. DoodleBears commented on Sep 18, 2026

    @DoodleBears
    ContributorAuthor

    v1.9 内容同步状态(2026-09-18):spec v1.9 / PRD v1.3 / CONTEXT 词表 / ADR-0026(增补)+0029+0030 / 新 changelog 已随站点构建发布(手动 pnpm docs:deploy,botharness.ai 与 botharness.dev 同一 Worker)。另新增用户指南 /docs/concepts(#45)。

    对本次 IA 重组的输入:站点未来作为产品主站(landing / guide / docs / changelog / marketplace)的分区与导航,需要把"概念页"与"marketplace(用户上传的 Bot)"一并纳入信息架构;当前 /docs 下已有 overview / quickstart / concepts 三页。

  2. added this to the v1.1 milestone on Sep 18, 2026
  3. added and removed
    needs-triageMaintainer needs to evaluate this issue
    on Sep 20, 2026
  4. self-assigned this
    on Sep 20, 2026
  5. moved this from Todo to In Progress in Roadmapon Sep 20, 2026
  6. moved this from In Progress to Done in Roadmapon Sep 20, 2026
  7. closed this as completedby moving to Done in Roadmapon Sep 20, 2026
  8. added
    V1.1Milestone v1.1; mirrors the GitHub milestone
    on Sep 22, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

Labels

V1.1Milestone v1.1; mirrors the GitHub milestonewayfinder:taskWayfinder task ticket

Type

No type

Projects

  • Status
    Done

Relationships

None yet

Development

No branches or pull requests

Issue actions