Skip to content

Commit 0d45b71

Browse files
authored
add AI usage section (#464)
1 parent 25ae54e commit 0d45b71

File tree

4 files changed

+24
-3
lines changed

4 files changed

+24
-3
lines changed

docs/docs/ai-usage.md

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
# AI Usage
2+
3+
## Cursor
4+
5+
You can use the Docs feature to add Hypergraph documentation and reference it in your prompts.
6+
7+
1. Type `@docs` and select `Add new doc`
8+
2. Provide the `https://docs.hypergraph.thegraph.com/llms-full.txt` URL
9+
3. Add `Hypergraph` as the name
10+
11+
Now you can mention `@Hypergraph` in your prompts whenever you work with Hypergraph.
12+
13+
## Docs for LLMs
14+
15+
We support the [llms.txt](https://llmstxt.org/) standard for making documentation available to llms.
16+
17+
We offer the following pages:
18+
19+
- [`/llms.txt`](/llms.txt) — a listing of the available pages
20+
- [`/llms-full.txt`](/llms-full.txt) — complete documentation for Effect

docs/docs/query-public-data.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -35,7 +35,7 @@ const { data: spaceAData } = useQuery(Event, { mode: 'public', space: 'space-a-i
3535
const { data: spaceBData } = useQuery(Event, { mode: 'public', space: 'space-b-id' });
3636
```
3737

38-
### Filtering (not yet supported)
38+
### Filtering
3939

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

docs/docusaurus.config.js

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@ const config = {
2424
organizationName: 'graphprotocol',
2525
projectName: 'hypergraph',
2626

27-
onBrokenLinks: 'throw',
27+
onBrokenLinks: 'warn',
2828
onBrokenMarkdownLinks: 'warn',
2929

3030
// Even if you don't use internationalization, you can use this field to set
@@ -69,6 +69,7 @@ const config = {
6969
{
7070
includeOrder: [
7171
'quickstart',
72+
'ai-usage',
7273
'key-features',
7374
'core-concepts',
7475
'typesync',

docs/sidebars.js

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ const sidebars = {
1818
// By default, Docusaurus generates a sidebar from the docs folder structure
1919
docs: [
2020
{ type: 'doc', id: 'quickstart', label: '🚀 Quickstart' },
21-
// { type: 'doc', id: 'faucet', label: '🪙 Testnet Faucet' },
21+
{ type: 'doc', id: 'ai-usage', label: '✨ AI Usage' },
2222
{ type: 'doc', id: 'key-features', label: '🌟 Key Features' },
2323
{ type: 'doc', id: 'core-concepts', label: '🧠 Core Concepts' },
2424
{ type: 'doc', id: 'typesync', label: '🧬 TypeSync' },

0 commit comments

Comments
 (0)