Skip to content

Commit 8010a58

Browse files
zackkatzclaude
andcommitted
docs: Simplify IDE integration instructions
Focus on "Add Custom Docs" feature for Cursor and Windsurf. Remove misleading MCP server section. Streamline instructions for other IDEs. 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
1 parent 836adf4 commit 8010a58

File tree

1 file changed

+49
-4
lines changed

1 file changed

+49
-4
lines changed

README.md

Lines changed: 49 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -240,14 +240,14 @@ The hooks API provides programmatic access to all hook information:
240240

241241
```bash
242242
# Discover available products (lightweight - 6KB)
243-
curl https://gravitykit.dev/api/hooks/index.json
243+
curl https://www.gravitykit.dev/api/hooks/index.json
244244

245245
# Get hooks for a specific product (recommended)
246-
curl https://gravitykit.dev/api/hooks/gravityview.json
247-
curl https://gravitykit.dev/api/hooks/gravityedit.json
246+
curl https://www.gravitykit.dev/api/hooks/gravityview.json
247+
curl https://www.gravitykit.dev/api/hooks/gravityedit.json
248248

249249
# Full database (large - 728KB, use per-product instead)
250-
curl https://gravitykit.dev/api/hooks.json
250+
curl https://www.gravitykit.dev/api/hooks.json
251251
```
252252

253253
### Regenerating LLM Enhancements
@@ -256,6 +256,51 @@ curl https://gravitykit.dev/api/hooks.json
256256
npm run llm:enhance # Regenerate JSON APIs and add examples
257257
```
258258

259+
## IDE Integration
260+
261+
Add GravityKit hooks documentation to your AI-powered code assistant.
262+
263+
### Cursor
264+
265+
1. Open Cursor Settings (`Cmd/Ctrl + ,`)
266+
2. Go to **Features****Docs**
267+
3. Click **Add new doc**
268+
4. Enter: `https://www.gravitykit.dev`
269+
270+
Cursor will index the documentation and use it when answering questions about GravityKit plugins.
271+
272+
### Windsurf
273+
274+
1. Open Windsurf Settings
275+
2. Go to **Cascade****Memories & rules**
276+
3. Under **Indexed Docs**, click **Add**
277+
4. Enter: `https://www.gravitykit.dev`
278+
279+
### Other IDEs
280+
281+
For IDEs without built-in doc indexing, add to your project instructions file:
282+
283+
**VS Code** (`.github/copilot-instructions.md`):
284+
```markdown
285+
Reference GravityKit hooks at https://www.gravitykit.dev
286+
API: https://www.gravitykit.dev/api/hooks/{product}.json
287+
```
288+
289+
**Claude Code** (`CLAUDE.md`):
290+
```markdown
291+
Fetch GravityKit hooks from https://www.gravitykit.dev/api/hooks/{product}.json
292+
```
293+
294+
### Available Endpoints
295+
296+
| Endpoint | Description |
297+
|----------|-------------|
298+
| `/llms.txt` | LLM-optimized context file |
299+
| `/api/hooks/index.json` | Product directory with hook counts |
300+
| `/api/hooks/{product}.json` | All hooks for a specific product |
301+
302+
**Products**: `gravityview`, `gravitycalendar`, `gravitycharts`, `gravityedit`, `gravityexport`, `gravityimport`, `gravitymath`, `gravityactions`, `gravityboard`, `gravitymigrate`, `gravityrevisions`, and more.
303+
259304
## Environment Variables
260305

261306
The site uses environment variables for optional integrations. Set these in your deployment environment or local `.env` file.

0 commit comments

Comments
 (0)