mirror of
https://github.com/cloudflare/skills.git
synced 2026-11-04 09:05:00 +00:00
vance
41e0d19858
* Cleanup docs links, prefer explicit markdown routes Not all agents do content negotiation, so link <route>/index.md directly. * Add markdown route rule to CONTRIBUTING
1.2 KiB
1.2 KiB
Contributing
Keep skills small: help agents find the right documentation instead of maintaining another copy of it.
For changes to skills, commands, or bundled references:
- Read the relevant page on Cloudflare's developer documentation and verify that it supports the proposed guidance; a working URL alone is not enough.
- Link directly to the relevant product or workflow page. Prefer links over duplicated API signatures, limits, pricing, configuration, or examples that can become stale.
- Link
developers.cloudflare.compages by their markdown route (<route>/index.md, e.g.https://developers.cloudflare.com/workers/index.md), not the HTML route. Not every agent does content negotiation, so the explicit route guarantees markdown. Usehttps://developers.cloudflare.com/llms.txtfor the docs root. Keep human-facing files (README, plugin manifests) on HTML routes. - When correcting outdated reference content, replace it with a short pointer to the current documentation where possible.
- If the required guidance is missing from
developers.cloudflare.com, describe the documentation gap in the pull request rather than adding unsupported guidance to a skill.