docs: Savanna documentation refresh, LLM export, and video walkthrough - #168
Open
ngarakapati wants to merge 10 commits into
Open
docs: Savanna documentation refresh, LLM export, and video walkthrough#168ngarakapati wants to merge 10 commits into
ngarakapati wants to merge 10 commits into
Conversation
Ignore Antora build artifacts, editor files, and support configurable PORT for the gulp preview server.
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.
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.
…onent xrefs Refresh security, solutions, and start pages for Cloud Classic and convert unresolvable xrefs to external docs.tigergraph.com links.
Embed Savanna_Database_Secrets.mp4 in the create-database-secret guide to demonstrate the flow in Savanna.
✅ Deploy Preview for thriving-strudel-91d4a9 ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
Remove the fixed width attribute so video sizing is controlled by the theme videoblock styles.
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.
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.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Major refresh of Savanna documentation content and navigation, plus tooling for local preview and LLM-friendly exports. Includes a walkthrough video on the database secret guide.
Savanna documentation
release-notes.adocwithchangelog.adocin overviewSavanna_Database_Secrets.mp4on the create-database-secret pageCloud Classic
Build & preview tooling
antora-playbook.local.ymlfor local UI development against siblingantora-uirepomarkdown-for-llm.js,llms-txt.js,llm-utils.jsgulpfile.jsandpackage.jsonscripts (build:local,dev).gitignorefor build artifacts and local toolingMerge order
Merge the companion
antora-uiPR first, then merge this PR. The production playbook fetchesbuild/ui-bundle.zipfromtigergraph/antora-ui@main— the UI bundle must land before this site rebuilds.Test plan
npm run build:localwith local antora-ui theme builds successfullynpm run devserves site at localhost with live reloadnpm run build(production playbook) succeeds after antora-ui PR is merged