spike(framework): assess offline reliability of tool documentation references

未关闭
#1,235 0 条评论 0 个 reaction 已指派 0 人 在 GitHub 查看

维护者通常 1 天内回复

还没有人认领这个 Issue。

评估

难度
4/5
预计耗时
3-5 天
新手友好度
30/100
Issue 类型
文档
描述清晰度
基本清楚
活跃度
活跃

调研方向

Start by inventorying external vendor-documentation URLs in the installed skills, beginning with plugins/aidd-context/skills/06-agent-generate/references/tool-paths.md, 04-skill-generate/references/tool-write.md and 08-hook-generate/references/tool-paths.md, and classify each as citation, optional verification or required runtime lookup. Then run representative generation flows with documentation domains unreachable and record what the agent does. Done means a written inventory, reproduction results, and a recommendation with any follow-up issues scoped separately.

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

描述

Problem

AIDD's tool-specific generation skills contain official documentation URLs for Kilo Code, Claude Code, Codex, OpenCode, Cursor, Copilot and other hosts. Source links are important for verifying platform contracts, but external documentation domains can be inaccessible in restricted enterprise networks.

Not every link creates a runtime dependency: many references already describe the contract locally. However, some instructions explicitly tell the agent to consult vendor documentation for information not recorded in the installed reference (for example, supported hook events). It is not yet established whether those workflows continue safely and reliably when the documentation cannot be reached.

This is a research spike, not a demonstrated product bug. The goal is to determine whether there is an actual offline-runtime gap and agree on an approach before proposing implementation changes.

Scope

  • Inventory external vendor-documentation links in the installed AIDD skills, references, agents and rules; classify each as a citation, optional verification or potentially required runtime lookup.
  • Trace representative generation flows for agents, skills, rules, commands/workflows and hooks across the supported hosts.
  • Run reproducible restricted-network scenarios where vendor documentation access is unavailable, distinguishing cases with a locally sufficient contract from those that require missing information.
  • Identify whether agents fail closed, invent unsupported facts, skip mandatory validation or block unnecessarily when a source is unavailable.
  • Propose a framework-wide convention for locally sufficient execution contracts, optional source verification, evidence freshness and explicit handling of unknown or unverified behavior.
  • Identify small follow-up implementation issues only where a reproducible gap exists, without requiring wholesale copies of vendor documentation.

Acceptance criteria

  • A documented inventory identifies external documentation lookups and their role (citation / optional / required) with file references.
  • Representative supported generation workflows are tested with documentation domains unreachable; reproduction steps and observed results are recorded.
  • The report distinguishes actual runtime dependencies from harmless source links and identifies the behavior when a required fact cannot be verified.
  • A proposed convention preserves official URLs, evidence provenance and verification dates while defining what must be available locally for reliable generation.
  • Any limitations, security considerations and maintenance trade-offs (including documentation drift) are documented.
  • The spike concludes with a clear recommendation and separately scoped follow-up issues, if warranted.

Prior art in this repo

  • #618 — source-backed, dated and auditable tool references. Its requirement to avoid guessing tool behavior must remain intact.
  • #1149 — deterministic framework-file validation; related, not a replacement for offline workflow testing.
  • PR #992 — Kilo-native generation; example references:
    • plugins/aidd-context/skills/06-agent-generate/references/tool-paths.md: local agent mapping plus official vendor links.
    • plugins/aidd-context/skills/04-skill-generate/references/tool-write.md: locally defined targets with sourced platform contracts.
    • plugins/aidd-context/skills/08-hook-generate/references/tool-paths.md: requests external documentation checks for some hook events.
  • aidd_docs/README.md describes local marketplace installation for offline use; this spike examines workflows after installation, not marketplace download.

Out of scope

  • Blocking or expanding PR #992 solely because it contains external documentation URLs.
  • Removing official sources or replacing evidence-backed claims with unsourced assumptions.
  • Vendoring entire provider documentation sites or introducing a live network requirement into every generation.
  • Implementing a fallback, caching system or large-scale refactor before the investigation establishes a concrete need.
主要语言
TypeScript
星标
481
派生
45
平均合并
1 天 13 小时
30 天内合并 PR
91

环境准备

从这里开始

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

ai-driven-dev/framework 的其他 Issue

查看 ai-driven-dev/framework 的全部 Issue

相似的 Issue

更多 TypeScript Issue

把新 issue 发到你的邮箱

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