diff --git a/docs/docs/ai-usage.md b/docs/docs/ai-usage.md new file mode 100644 index 00000000..6694c384 --- /dev/null +++ b/docs/docs/ai-usage.md @@ -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 diff --git a/docs/docs/query-public-data.md b/docs/docs/query-public-data.md index 81602b92..6c0e6f4b 100644 --- a/docs/docs/query-public-data.md +++ b/docs/docs/query-public-data.md @@ -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. diff --git a/docs/docusaurus.config.js b/docs/docusaurus.config.js index 2e9bf73f..90cc125a 100644 --- a/docs/docusaurus.config.js +++ b/docs/docusaurus.config.js @@ -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 @@ -69,6 +69,7 @@ const config = { { includeOrder: [ 'quickstart', + 'ai-usage', 'key-features', 'core-concepts', 'typesync', diff --git a/docs/sidebars.js b/docs/sidebars.js index 15bfe984..15ab2c66 100644 --- a/docs/sidebars.js +++ b/docs/sidebars.js @@ -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' },