docs: Savanna documentation refresh, LLM export, and video walkthrough - #171
Open
ngarakapati wants to merge 20 commits into
Open
docs: Savanna documentation refresh, LLM export, and video walkthrough#171ngarakapati wants to merge 20 commits into
ngarakapati wants to merge 20 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.
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.
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.
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.
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.
✅ Deploy Preview for thriving-strudel-91d4a9 ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
Author
|
Closing this. A new PR will be opened from |
Author
|
Reopened. This PR stays on |
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.
Use changelog.adoc as the page name and nav target. Keep a release-notes alias so existing bookmarks still work.
Drop the changelog filename and wording so Savanna matches the live /release-notes path. Redirects are no longer needed.
The navbar reads site.title from the playbook. Restore Docs so local and production playbooks match the previous header.
antora-playbook.local.yml is machine-specific (sibling UI path). Stop tracking it and ignore it so only antora-playbook.yml ships.
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.
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.
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
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 currentorigin/main, including the Aug 19 changelog notes that had been dropped when release notes were rewritten as a changelog.Savanna documentation
release-notes.adocwithchangelog.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)Cloud Classic
xref:shttps://www.tigergraph.com/docs/...(they open as external links)Build and preview
antora-playbook.local.ymlfor local preview against a siblingantora-uicheckoutllms.txtfor AI toolingpackage.jsonscripts forbuild:localanddev.gitignorefor build output and editor filesbuild/ui-bundle.zipfromtigergraph/antora-ui. The Savanna/Classic look is applied in the UI with atheme-cloudclass, so we do not need a separateui-bundle-cloud.zipMerge order
Merge tigergraph/antora-ui#47 first, then this PR. Production fetches the UI zip from
antora-uimain. If this merges first, the site can rebuild with the old bundle.Test plan
npm run build:localwith local antora-ui succeedsnpm run build(production playbook) succeeds after the antora-ui PR is merged