ext/hyperframes
2
0
Fork 0
mirror of https://github.com/heygen-com/hyperframes.git synced 2026-09-03 12:54:29 +00:00
Code Issues Packages Projects Releases Wiki Activity

fix(cli): point agents to docs CLI and llms.txt instead of guessing URLs

Browse Source 
The shared CLAUDE.md in scaffolded projects mentioned
hyperframes.heygen.com alongside doc topic names, causing AI agents
to guess incorrect URLs like /compositions instead of using the local
`hyperframes docs` CLI command or the correct /concepts/compositions
path. Now explicitly directs agents to use the CLI for quick reference
and llms.txt for full doc URL discovery.
This commit is contained in:
James
2026-03-27 22:22:47 +00:00
parent b6e2d74cb7
commit fff87300f1
1 changed files with 14 additions and 2 deletions
Download Patch File Download Diff File Expand all files Collapse all files
packages/cli/src/templates/_shared/CLAUDE.md
+14 -2
View File
@@ -25,9 +25,21 @@ npx hyperframes lint # validate compositions
npx hyperframes docs <topic> # reference docs in terminal
```
Available doc topics: `data-attributes`, `gsap`, `compositions`, `rendering`, `templates`, `troubleshooting`
## Documentation
Full docs: [hyperframes.heygen.com](https://hyperframes.heygen.com)
**For quick reference**, use the local CLI docs command (no network required):
```bash
npx hyperframes docs <topic>
```
Topics: `data-attributes`, `gsap`, `compositions`, `rendering`, `templates`, `troubleshooting`
**For full documentation**, discover pages via the machine-readable index — do NOT guess URLs:
```
https://hyperframes.heygen.com/llms.txt
```
## Project Structure