Beads — Deliberately Short Entry Point
claude-md-exampleFiles & storageThis is a deliberately short entry point file for an AI agent working in a project. It opens by stating that it is intentionally short, links to the canonical AGENTS.md, instructions, and architecture docs, and lists only the few ground rules that must be seen first. It also encodes a conflict-resolution rule: trust the linked source and delete the duplicate here.
Unavailable. Delivery for this kind is on the roadmap — not serving yet.
Add to setup to save this item as a reference. Ahel cannot run it, and signing in will not install it.
What your AI can do with it
- States at the top that the file is intentionally short.
- Links to the canonical AGENTS.md, instructions, and architecture docs.
- Lists only the few ground rules that must be seen first.
- Encodes a conflict-resolution rule: trust the linked source.
- Tells the agent to delete any duplicate rule kept here.
Getting started
- Save this item in Your setup as a reference.
- Read the source or reference documentation for its setup requirements. Saving it here does not connect it to your AI.
- Check this page for availability before trying to install it through Ahel.
Signals
- GitHub stars
- 28k
- Forks
- 2k
- Last commit
- Oct 2026
Questions
- What is this file for?
- It gives an AI agent a short entry point that links to full project docs and lists only the must-see ground rules.
- Why is the file short?
- It is intentionally short so the agent sees only the few ground rules that must be seen first, then follows links to the full docs.
- What happens if a rule here conflicts with a linked doc?
- Trust the linked source and delete the duplicate here.
- Does it replace the full project docs?
- No. It links to the canonical AGENTS.md, instructions, and architecture docs instead of repeating them.
Advanced
- Item type
- claude-md-example
- Key
beads-short-entry-point- Source
- github.com/gastownhall/beads