Skip to content

docs: Savanna documentation refresh, LLM export, and video walkthrough - #171

Merged
Tushar-TG-14 merged 23 commits into
tigergraph:mainfrom
ngarakapati:feat/savanna-docs-and-ui
Sep 2, 2026
Merged

docs: Savanna documentation refresh, LLM export, and video walkthrough#171
Tushar-TG-14 merged 23 commits into
tigergraph:mainfrom
ngarakapati:feat/savanna-docs-and-ui

Conversation

@ngarakapati

@ngarakapati ngarakapati commented Aug 26, 2026

Copy link
Copy Markdown
Contributor

Summary

This is the Savanna + Cloud Classic docs update that goes with the Antora UI theme PR. It refreshes the Savanna guides, fixes Cloud Classic links that could not resolve in this repo, and adds local/LLM build tooling.

Supersedes #168. That PR was opened from fork main. This branch is the same work, rebased onto current origin/main, including the Aug 19 changelog notes that had been dropped when release notes were rewritten as a changelog.

Savanna documentation

  • Reorganize the left nav across administration, get started, graph development, integrations, overview, resources, REST API, and workgroups
  • Add new pages: connect an agent with MCP, first graph in the UI, and how to create a database secret
  • Replace release-notes.adoc with changelog.adoc, and keep the Aug 19, 2026 notes (billing platform transition as a product change; Add Solution / Add-ons items under Bug fixes, same pattern as the rest of the changelog)
  • Refresh workgroup/workspace guides and screenshots
  • Embed the database secret walkthrough video and rewrite that page so it starts with what a secret is, then the video, then the steps

Cloud Classic

  • This playbook only builds Savanna and Cloud Classic, so links into Server, GraphStudio, GSQL, and Insights cannot be in-site xref:s
  • Those are now normal links to https://www.tigergraph.com/docs/... (they open as external links)
  • A later screenshot commit had put the old xrefs back; this branch restores the external links so the local/CI build stays clean

Build and preview

  • antora-playbook.local.yml for local preview against a sibling antora-ui checkout
  • Antora extensions that emit per-page Markdown and llms.txt for AI tooling
  • Gulp/package.json scripts for build:local and dev
  • Broader .gitignore for build output and editor files
  • Production playbook still uses build/ui-bundle.zip from tigergraph/antora-ui. The Savanna/Classic look is applied in the UI with a theme-cloud class, so we do not need a separate ui-bundle-cloud.zip

Merge order

Merge tigergraph/antora-ui#47 first, then this PR. Production fetches the UI zip from antora-ui main. If this merges first, the site can rebuild with the old bundle.

Test plan

  • npm run build:local with local antora-ui succeeds
  • Savanna nav and new pages render (MCP, first graph, database secret)
  • Changelog shows Aug 19 (billing transition + Bug fixes) then Aug 5
  • Database secret page: intro, video with play overlay, current UI steps
  • Cloud Classic FAQs and related pages use docs.tigergraph.com links, not broken xrefs
  • npm run build (production playbook) succeeds after the antora-ui PR is merged

@ngarakapati
chore: expand gitignore and local preview tooling
11111da 
Ignore Antora build artifacts, editor files, and support configurable PORT
for the gulp preview server.
@ngarakapati
feat: add LLM markdown export and dual playbook build setup
9b81190 
Publish llms.txt and per-page markdown twins for AI tooling, enable AsciiDoc
tabs, and split production and local Antora playbooks for CI vs UI dev.
@ngarakapati
docs(savanna): restructure navigation and refresh Savanna documentation
e824d7e 
Reorganize sidebar navigation, replace the get-started hub with console and
MCP onboarding guides, migrate release notes to a changelog, refresh landing
pages and section hubs, and update workgroup, build, and administration docs.
@ngarakapati
docs(cloud): update Cloud Classic pages and replace broken cross-comp…
8393c91 
…onent xrefs

Refresh security, solutions, and start pages for Cloud Classic and convert
unresolvable xrefs to external docs.tigergraph.com links.
@ngarakapati
fix: include workgroup screenshots and latest cloud cross-reference u…
03da867 
…pdates
@ngarakapati
docs(savanna): add database secret walkthrough video
d3a1466 
Embed Savanna_Database_Secrets.mp4 in the create-database-secret guide to
demonstrate the flow in Savanna.
@ngarakapati
docs(savanna): let database secret video use full content width
11324a0 
Remove the fixed width attribute so video sizing is controlled by the
theme videoblock styles.
@ngarakapati
build: point UI bundle at cloud-only ui-bundle-cloud.zip
cbd0db2 
Use the dedicated cloud bundle so the Savanna/Classic theme is scoped to
cloud-docs and does not depend on the shared default UI bundle. Resolves
once tigergraph/antora-ui#46 (which adds build/ui-bundle-cloud.zip) merges.
@ngarakapati
ci: retrigger build/Netlify now that ui-bundle-cloud.zip is on antora…
73da191 
…-ui main
@ngarakapati
docs(savanna): rework database secrets page for clarity
f9660cf 
Lead with a concept-first explanation of what a database secret is,
move the walkthrough video directly after the intro (no caption), align
the creation steps with the current Savanna UI, and add a "Use a
database secret" section listing pyTigerGraph, TigerGraph MCP, and
GraphRAG.
@ngarakapati
fix(cloud): restore external links for cross-component xrefs
20e5dd1 
A later screenshot update had put gui/tigergraph-server/gsql-ref
xrefs back. This playbook only includes savanna and cloud, so those
targets cannot resolve. Point at docs.tigergraph.com again.
@ngarakapati
docs(savanna): add Aug 19 changelog entries from origin/main
b9c8661 
The docs restructure replaced release-notes.adoc with changelog.adoc
and dropped the Aug 19 billing-transition and bug-fix notes that were
already on origin/main.
@ngarakapati
docs(savanna): group Aug 19 workspace fixes under Bug fixes
b557011 
Match the rest of the changelog: named headings are for product
changes; the Add Solution and Add-ons items are bug fixes, not
standalone features.
@netlify

netlify Bot commented Aug 26, 2026 •
edited
Loading

Copy link
Copy Markdown

✅ Deploy Preview for thriving-strudel-91d4a9 ready!

Name Link
🔨 Latest commit 5c85930
🔍 Latest deploy log https://app.netlify.com/projects/thriving-strudel-91d4a9/deploys/6a98783ff574f70008ecf2aa
😎 Deploy Preview https://deploy-preview-171--thriving-strudel-91d4a9.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify project configuration.

@ngarakapati

ngarakapati commented Aug 26, 2026

Copy link
Copy Markdown
Contributor Author

Closing this. A new PR will be opened from ngarakapati:main instead of feat/savanna-docs-and-ui.

@ngarakapati ngarakapati reopened this Aug 26, 2026
@ngarakapati

ngarakapati commented Aug 26, 2026

Copy link
Copy Markdown
Contributor Author

Reopened. This PR stays on feat/savanna-docs-and-ui, which already matches current local main, including the Aug 19 changelog entries. Merge after the antora-ui PR: tigergraph/antora-ui#47

@ngarakapati
docs(savanna): keep live release-notes URL and alias changelog
8d58756 
The published Savanna page is /overview/release-notes. Keep that filename so existing bookmarks and origin/main updates still hit the same path. Nav still says Changelog; /changelog redirects to it.
@ngarakapati
docs(savanna): make changelog the public URL
78fde3b 
Use changelog.adoc as the page name and nav target. Keep a release-notes alias so existing bookmarks still work.
@ngarakapati
docs(savanna): use Release Notes for the page name, nav, and URL
01fe239 
Drop the changelog filename and wording so Savanna matches the live /release-notes path. Redirects are no longer needed.
@ngarakapati
docs: keep the site title as Docs
54c297d 
The navbar reads site.title from the playbook. Restore Docs so local and production playbooks match the previous header.
@ngarakapati
chore: keep the local Antora playbook out of the PR
1dd7db7 
antora-playbook.local.yml is machine-specific (sibling UI path). Stop tracking it and ignore it so only antora-playbook.yml ships.
@ngarakapati
build: stop generating a Savanna-only /llms.txt
51f501b 
Leave lib/llms-txt.js in the repo for later. This playbook only has Savanna and Cloud Classic, so it must not publish the site-wide docs index.
@ngarakapati
fix: map drop-style page URLs when publishing markdown twins
9526684 
Keep htmlToMdUrl in sync with the UI helper so slash-style page URLs
still get an index.md twin for Copy page and the LLM actions.
@ngarakapati ngarakapati mentioned this pull request Aug 26, 2026
Merged
@ngarakapati
chore: rebuild Netlify preview against antora-ui main
85db3af 
Pick up the merged md-url helper from tigergraph/antora-ui#48.
@ngarakapati
chore: rebuild Netlify preview against antora-ui tabs fix
6a8a6b5 
Pick up tigergraph/antora-ui#49 so Cursor / Claude Desktop / VS Code /
Claude Code tabs switch on the MCP page.
@Tushar-TG-14

Tushar-TG-14 commented Sep 2, 2026

Copy link
Copy Markdown
Collaborator

@ngarakapati

  1. Can you confirm that internal links in the generated .md files resolve to the corresponding .md pages, including the clean /page/ URLs used by the production site? I want to make sure the LLM Markdown output doesn't link back to HTML pages.

  2. Can you confirm the MCP setup was tested end-to-end for at least one client using the documented uvx + TG_HOST + TG_SECRET configuration, and that the sample List the graphs... prompt successfully returns graph information?

  3. I noticed the PR description says release-notes.adoc is replaced by changelog.adoc, but the current diff still keeps release-notes.adoc. Is the file intentionally staying as release-notes.adoc, with only the page presentation changing?

  4. I noticed that the Products dropdown formatting in the PR docs: Savanna documentation refresh, LLM export, and video walkthrough #171 preview looks different from production. The indentation/spacing and separators between the product links don't appear to match the current production dropdown. Could we verify that the Products dropdown retains the same structure and spacing as production for the other products?

@ngarakapati

ngarakapati commented Sep 2, 2026 •
edited
Loading

Copy link
Copy Markdown
Contributor Author

@Tushar-TG-14

  1. Yes. Generated .md twins rewrite in-site links to Markdown, not HTML. On this preview that is foo.html → foo.md (see overview/index.md). Production uses drop-style /page/ URLs; the Copy / View as Markdown buttons map those to index.md / page.md via the helper shipped in antora-ui#48. [View as HTML] in the Markdown file is the only intentional HTML link.

  2. Yes. MCP was tested end to end against a Savanna workspace with the documented uvx + TG_HOST + TG_SECRET (and optional TG_GRAPHNAME) config on Connect AI tools with MCP. The sample prompt List the graphs available in my TigerGraph database returned graph information.

  3. Yes. release-notes.adoc is staying. The published URL is /savanna/main/overview/release-notes (live). We briefly tried changelog.adoc, then kept the live filename so bookmarks and origin/main updates still hit the same path (8d58756, 01fe239). Only the page presentation changed. The PR description mentioning a replace with changelog.adoc is leftover and should be ignored.

  4. The Products dropdown in this preview looks different because the cloud-docs playbook only builds Savanna and Cloud Classic. Handlebars then emits empty href="#" items for Server, Suite, GSQL, etc., and those empty items still get the grey separators. Production is built by doc-site with every product, so the live dropdown keeps the current structure and spacing. After this PR merges into the full site build, that production dropdown is unchanged.

@ngarakapati
docs: merge main and add Sep 2 Savanna release notes
5c85930 
Keep the rewritten release-notes format from this PR and include the Sep 2 entries that landed on main (database secrets, workspace size limit, backup restore, empty query results, billing theme, org-login 403). Also bring in DOC-3325 FAQ link fixes.
@Tushar-TG-14
Tushar-TG-14 merged commit 28660be into tigergraph:main Sep 2, 2026
4 of 5 checks passed
@ngarakapati
ngarakapati deleted the feat/savanna-docs-and-ui branch September 2, 2026 19:41
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

No reviews

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

2 participants

@ngarakapati @Tushar-TG-14