[self-care:documentation-discoverability] Agent documentation routing defects

未关闭 适合新手
  • 哪里不对？
#20,667 0 条评论 0 个 reaction 已指派 0 人 在 GitHub 查看

维护者通常 1 天内回复

还没有人认领这个 Issue。

评估

难度
2/5
预计耗时
1-3 小时
新手友好度
72/100
Issue 类型
文档
描述清晰度
描述清楚
活跃度
活跃
技术栈
javascript
领域
documentation

调研方向

先从 docs/deployment.md、docs/configuration.md 和 docs/dashboard-data-ingestion.md 开始，然后追踪 llms.txt 如何通过 resources.json 跳转到文档页面。添加一个范围明确、权威的托管 Redis 章节，并使其可通过该路径访问；重新运行可发现性审计，确认任务 8 无需备用搜索即可成功。

由索引模型根据 Issue 内容生成。

描述

self-care self-care:documentation-discoverability

Routing succeeded for 9 of 10 tasks (90%). Task 8 (configure hosted Redis) fails: no routed document covers it, and a bounded repository search was needed.

Action: Fix the listed authoritative routing defects and rerun this audit.

Metrics
  • Routing success: 9/10 (90%)
  • Document hops: average 1.5, maximum 2
  • Fallback searches: 1
  • Dead ends: 1
  • Missing documents: 1
  • Contradictions: 0
  • Obsolete references: 0
Task results
Per-task table
# Task First doc Next doc Hops Unambiguous Answered Fallback Dead end Missing Contradiction Obsolete
1 Campaign execution authority resources.json authority-envelopes 2 true true false false none false none
2 Add a new campaign create-cao-campaign skill none 1 true true false false none false none
3 Change dashboard canonical data model resources.json dashboard-data-model 2 true true false false none false none
4 Implement a Dashboard Language query resources.json dashboard-language 2 true true false false none false none
5 Activity workflow-metadata collection resources.json activity 2 true true false false none false none
6 Worker authority constraints resources.json orchestrators-and-workers 2 true true false false none false none
7 Debug a failed CAO deployment debug-cao skill none 1 true true false false none false none
8 Configure hosted Redis resources.json deployment 2 false false true true hosted Redis configuration page or section false none
9 Add a CAO CLI command cao-cli skill none 1 true true false false none false none
10 Set up CAO via setup-cao setup-cao skill none 1 true true false false none false none
Required remediation
  • Task 8: llms.txt, resources.json and llms-small.txt give no route to hosted Redis guidance. llms-small.txt mentions Redis only to say it is not required for the local dashboard. Source files exist in docs/configuration.md and docs/dashboard-data-ingestion.md.
  • Add a bounded Redis section to docs/deployment.md, or to the authoritative configuration page. It must be reachable from llms.txt through resources.json, with a resource entry or a link from the deployment page. Alternatively, add the Redis topic to the description of an existing routed resource.
Evidence
Retrieval and validation

  • Public URL: https://githubnext.github.io/gh-cao/llms.txt (retrieval status: available)

  • SHA-256 digests:

    • llms.txt: 296aa723791831f8ec71a3e6c2fd938ab074ce05e731db2c857ced2a7db69f84
    • resources.json: 3d1d9d7fc269b8906b8e76001ae622d705cd2ec5700362f688f62728dc8c46e5
    • resource.json: f205fc73ebb4ff14620a21a626a04b6e46659a09b19fb6a3691db170fa754c81
    • catalog-resource.json: b8ebd3eabfa5c5fda79dddb604e229a3cc92ea6da9a705ca1b58b0964db1742d

  • resources.json: 62 resources, sorted by id, all URLs under https://githubnext.github.io/gh-cao/.

  • resource.json: has source, provenance (commit d4bf131), freshness and sha256 integrity. It exposes only read-only cao pages, cao_catalog and cao_overview bindings.

  • catalog-resource.json: has executable read-only cao_catalog bindings for both pages and queries.

  • Fallback for task 8: one repository search for "redis" under docs/ and README.md matched docs/configuration.md, docs/control-policy-specification.md, docs/dashboard-data-ingestion.md and docs/dashboard.md. Only the match list was recorded and no file was opened. This counts as a discoverability failure.

  • Limitation: sampled per-page index.json fetches from the public site were not completed in this run. Task routing was judged from llms.txt, resources.json and llms-small.txt.

Control Plane

cao: githubnext/gh-cao, correlation: 43168974790-3862

Generated by SelfCare / Documentation Discoverability · copilot · auto (Claude Sonnet 5.5) · ~28 AIC · ⌖ ~2 AIC · ⊞ 15.5K · ◷

  • expires on Nov 26, 2026, 6:45 AM UTC
主要语言
JavaScript
星标
19
派生
4
平均合并
4 小时
30 天内合并 PR
708

环境准备

  • 没有 Dockerfile 或 Docker Compose 文件
  • 没有 Pull Request 模板
  • 阅读贡献指南

从这里开始

  1. 先读完整个 Issue，再读项目的贡献指南。
  2. 在 Issue 下留言说明你要接手 —— 这能避免两个人做同样的事。
  3. Fork 仓库，在一个分支上完成修改。
  4. 提交 Pull Request，并在描述里引用这个 Issue 编号。

githubnext/gh-cao 的其他 Issue

查看 githubnext/gh-cao 的全部 Issue

相似的 Issue

更多 JavaScript Issue

把新 issue 发到你的邮箱

精选适合新手参与的 GitHub issue 摘要。