Skip to content

add AI usage section #464

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 3 commits into from
Aug 11, 2025
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
20 changes: 20 additions & 0 deletions docs/docs/ai-usage.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
# AI Usage

## Cursor

You can use the Docs feature to add Hypergraph documentation and reference it in your prompts.

1. Type `@docs` and select `Add new doc`
2. Provide the `https://docs.hypergraph.thegraph.com/llms-full.txt` URL
3. Add `Hypergraph` as the name

Now you can mention `@Hypergraph` in your prompts whenever you work with Hypergraph.

## Docs for LLMs

We support the [llms.txt](https://llmstxt.org/) standard for making documentation available to llms.

We offer the following pages:

- [`/llms.txt`](/llms.txt) — a listing of the available pages
- [`/llms-full.txt`](/llms-full.txt) — complete documentation for Effect
2 changes: 1 addition & 1 deletion docs/docs/query-public-data.md
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,7 @@ const { data: spaceAData } = useQuery(Event, { mode: 'public', space: 'space-a-i
const { data: spaceBData } = useQuery(Event, { mode: 'public', space: 'space-b-id' });
```

### Filtering (not yet supported)
### Filtering

You can filter the data by passing in the `filter` parameter.

Expand Down
3 changes: 2 additions & 1 deletion docs/docusaurus.config.js
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ const config = {
organizationName: 'graphprotocol',
projectName: 'hypergraph',

onBrokenLinks: 'throw',
onBrokenLinks: 'warn',
onBrokenMarkdownLinks: 'warn',

// Even if you don't use internationalization, you can use this field to set
Expand Down Expand Up @@ -69,6 +69,7 @@ const config = {
{
includeOrder: [
'quickstart',
'ai-usage',
'key-features',
'core-concepts',
'typesync',
Expand Down
2 changes: 1 addition & 1 deletion docs/sidebars.js
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ const sidebars = {
// By default, Docusaurus generates a sidebar from the docs folder structure
docs: [
{ type: 'doc', id: 'quickstart', label: '🚀 Quickstart' },
// { type: 'doc', id: 'faucet', label: '🪙 Testnet Faucet' },
{ type: 'doc', id: 'ai-usage', label: '✨ AI Usage' },
{ type: 'doc', id: 'key-features', label: '🌟 Key Features' },
{ type: 'doc', id: 'core-concepts', label: '🧠 Core Concepts' },
{ type: 'doc', id: 'typesync', label: '🧬 TypeSync' },
Expand Down
Loading