github/deer-flow
1
0
Fork 0
mirror of https://github.com/bytedance/deer-flow.git synced 2026-11-13 14:50:36 +00:00
Code Issues Packages Projects Releases Wiki Activity
deer-flow/skills/AGENTS.md
Xinmin Zeng 2a97ec3e58
docs: turn README into an index and move reference detail to docs/guide (#8113) 
* docs: turn README into an index and move reference detail to docs/guide

The README had grown to 393 KB because every change appended its notes there. The text moves verbatim into 18 topic guides under docs/guide/; only headings are re-leveled and relative links re-pointed. The README keeps the introduction, a quick start and a guide index. Contributor test notes move to CONTRIBUTING.md.

* docs: send user docs to topic guides and budget the root README

The rule 'update README.md for user-facing changes' is what grew the README. Guidance now points to docs/guide/, and check_agent_guidance.py fails when the root README exceeds 16 KiB (AG003).

* chore: remove unreferenced screenshots and finished plan notes

pr-build/ holds two PR screenshots (3 MB) from #1986. plans/ holds the plan for the merged #4049. docs/SKILL_NAME_CONFLICT_FIX.md is a February change note. Nothing references them.

* docs: route always-loaded AGENTS.md files to scoped guides

* docs(agents): cut scoped guides to scope, verify, traps, decisions

Each AGENTS.md keeps four kinds of content: the scope of the directory, the
verification commands, traps a local test run does not show, and decisions the
code cannot state. Values, field lists, function inventories, test names, issue
numbers and history are deleted, because the code, the tests and git state them.

Search and fetch providers share one community guide. Four guides with no
remaining content are removed. The size check now allows 6 KiB per file (hard
limit 8 KiB) and 24 KiB per chain (hard limit 32 KiB).

* style: format frontend guide table and guidance test imports

---------

Co-authored-by: Willem Jiang <willem.jiang@gmail.com>
2026-11-11 13:26:17 +08:00

1.0 KiB
Raw Blame History

Skills (skills/)

public/ holds committed skills and custom/ holds local, gitignored skills. Tests for public skill scripts are in tests/skills/ at the repository root and run in Skill Review CI, independent of package review.

  • public/skill-reviewer/ is the built-in read-only reviewer. Its contracts are in contracts/skill_review/. Review data that the model sees is tag-neutralized, and raw payloads stay in tool artifacts.
  • CI waivers are in .github/skill-review-waivers.v1.json. Only the manifest from the trusted base revision can suppress a run, and a blocker finding cannot be waived.
  • Read SKILL.md as utf-8-sig and write text resources as utf-8. The platform locale is not reliable, and a leading BOM would become part of the content.
  • Skill script tests run offline. Test a dependency fallback with the optional import unavailable, and mock the HTTP transport.
  • A skill CLI exits non-zero on failure, with diagnostics on stderr and result URLs on stdout.