Skip to content

Update GraphQL Agent documentation #668

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.

Sign up for GitHub

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
ianhe8x merged 5 commits into from
Nov 2, 2025
Merged

Update GraphQL Agent documentation #668

Show file tree
Hide file tree
Changes from 4 commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
30f78d0
Update GraphQL Agent documentation
ianhe8x Oct 30, 2025
1b821ff
fix deploy-staging.yml
ianhe8x Oct 30, 2025
a9f8069
fix per comment
ianhe8x Oct 30, 2025
68b4927
remove sidebar for graphql agent
ianhe8x Oct 30, 2025
e73a077
remove sidebar for graphql agent
ianhe8x Oct 30, 2025
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
2 changes: 1 addition & 1 deletion .github/workflows/deploy-staging.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,7 @@ jobs:
- name: Invalidate CloudFront
uses: chetan/invalidate-cloudfront-action@v2
env:
DISTRIBUTION: GNUAPE6SUDC4
DISTRIBUTION: ${{ vars.CF_DISTRIBUTION_DEV }}
PATHS: "/*"
AWS_REGION: "us-east-1"
AWS_ACCESS_KEY_ID: ${{ vars.AWS_ACCESS_KEY_ID_V2 }}
Expand Down
4 changes: 2 additions & 2 deletions docs/.vuepress/config.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -70,8 +70,8 @@ j=d.createElement(s),dl=l!='dataLayer'?'&l='+l:'';j.async=true;j.src=
link: "/indexer/welcome.md",
},
{
text: "SubQuery AI Apps Framework",
link: "/ai/welcome.md",
text: "SubQuery GraphQL Agent",
link: "/ai/graphql_agent.md",
},
{
text: "SubQuery Network",
Expand Down
47 changes: 6 additions & 41 deletions docs/.vuepress/sidebar.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -719,47 +719,12 @@ export const getSidebar = (locale: string) =>
`${locale}/subquery_network/community.md`,
`${locale}/subquery_network/glossary.md`,
],
"/ai/": [
{
text: "Welcome",
link: `${locale}/ai/welcome.md`,
},
{
text: "Guides",
link: `${locale}/ai/guides/fancy-greeter.md`,
children: [
`${locale}/ai/guides/fancy-greeter.md`,
`${locale}/ai/guides/subquery-docs-rag.md`,
`${locale}/ai/guides/delegation-helper.md`,
],
},
{
text: "Build",
link: `${locale}/ai/build/app.md`,
children: [
`${locale}/ai/build/app.md`,
`${locale}/ai/build/function_tools.md`,
`${locale}/ai/build/rag.md`,
],
},
{
text: "Run",
link: `${locale}/ai/run/local.md`,
children: [
`${locale}/ai/run/local.md`,
`${locale}/ai/run/cli.md`,
`${locale}/ai/run/docker.md`,
],
},
{
text: "API",
link: `${locale}/ai/api/api.md`,
},
{
text: "Publish",
link: `${locale}/ai/publish/publish.md`,
},
],
// "/ai/": [
// {
// text: "SubQuery GraphQL Agent",
// link: `${locale}/ai/graphql_agent.md`,
// },
// ],
Copy link
Copy Markdown

@coderabbitai coderabbitai Bot Oct 30, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

⚠️ Potential issue | 🔴 Critical

🧩 Analysis chain

Clarify whether the AI sidebar section should be active.

The "/ai/" sidebar section is commented out, which means users won't see the "SubQuery GraphQL Agent" entry in the sidebar navigation. According to the AI summary, the navbar was updated to link to this documentation. If the navbar points to /ai/graphql_agent.md but the sidebar entry is disabled, this creates a navigation inconsistency—users can reach the page via the navbar but won't see it listed in the sidebar.

Questions:

  • Should this section be uncommented to make the documentation discoverable via the sidebar?
  • If it's intentionally disabled, consider adding a comment explaining why (e.g., // TODO: Enable after review or // Temporarily disabled pending content approval).
  • If this code is not needed, remove it entirely rather than leaving commented code.

Run the following script to check whether the navbar references this GraphQL Agent documentation:

🏁 Script executed:

#!/bin/bash
# Description: Check if navbar in config.ts references the GraphQL Agent doc

# Search for graphql_agent references in config.ts
rg -n "graphql_agent" docs/.vuepress/config.ts

# Also check if there's an active navbar item pointing to /ai/
rg -n -C2 '"/ai/|ai/graphql' docs/.vuepress/config.ts

Length of output: 158

Uncomment the AI sidebar section to match the active navbar entry.

Verification confirms the navbar in config.ts (lines 72-76) contains an active "SubQuery GraphQL Agent" link pointing to /ai/graphql_agent.md. However, the identical sidebar entry in sidebar.ts (lines 722-727) is commented out, creating a navigation inconsistency. Users can reach the documentation via the navbar but won't discover it through the sidebar menu.

Fix: Uncomment lines 722-727 in sidebar.ts to enable the sidebar entry and maintain navigation consistency.

🤖 Prompt for AI Agents 
In docs/.vuepress/sidebar.ts around lines 722 to 727, the AI sidebar entry is
commented out causing a mismatch with the active navbar; uncomment the block so
the sidebar contains the "SubQuery GraphQL Agent" entry pointing to
`${locale}/ai/graphql_agent.md` (remove the leading // from the three lines and
ensure the surrounding array/object remains syntactically correct).

"/miscellaneous/": [
`${locale}/miscellaneous/contributing.md`,
`${locale}/miscellaneous/social_media.md`,
Expand Down
48 changes: 0 additions & 48 deletions docs/ai/ai-app-framework.md
View file
Open in desktop

This file was deleted.

8 changes: 0 additions & 8 deletions docs/ai/api/api.md
View file
Open in desktop

This file was deleted.

160 changes: 0 additions & 160 deletions docs/ai/build/app.md
View file
Open in desktop

This file was deleted.

87 changes: 0 additions & 87 deletions docs/ai/build/function_tools.md
View file
Open in desktop

This file was deleted.

5 changes: 0 additions & 5 deletions docs/ai/build/other.md
View file
Open in desktop

This file was deleted.

Loading
Loading