Skip to content

feat(ui): Savanna docs theme, page actions, and video player - #45

Closed
ngarakapati wants to merge 4 commits into
tigergraph:mainfrom
ngarakapati:main
Closed

feat(ui): Savanna docs theme, page actions, and video player#45
ngarakapati wants to merge 4 commits into
tigergraph:mainfrom
ngarakapati:main

Conversation

@ngarakapati

Copy link
Copy Markdown
Contributor

Summary

Updates the Antora UI theme for Savanna and Cloud Classic documentation with refreshed typography, navigation, page-level actions, and embedded video support. Includes a rebuilt build/ui-bundle.zip so production builds pick up the changes immediately.

Theme & typography

  • Add theme-cloud.css with Savanna/Cloud styling
  • Switch to Inter/Outfit/JetBrains Mono via typeface-docs.css (replaces Roboto typefaces)
  • Refresh nav, doc, TOC, toolbar, and variable styles

Page actions

  • Add copy-as-Markdown and related page action UI (page-actions.css, 08-page-actions.js, page-actions.hbs)
  • Add md-url and has-current-page Handlebars helpers

Video blocks

  • Add videoblock.css for embedded video styling
  • Add 09-video-player.js click-to-play overlay for .videoblock elements

Navigation & layout

  • Improve nav tree behavior and current-page highlighting
  • Hide "Edit this Page" on Savanna and Cloud components
  • Update tabs block behavior (07-tabs-block.js)

Build

  • Rebuild build/ui-bundle.zip with all UI changes
  • Update font dependencies in package.json

Merge order

Merge this PR before the companion cloud-docs PR. Production fetches build/ui-bundle.zip from this repo at build time.

Test plan

  • Build UI locally: npx gulp build && npx gulp bundle:pack
  • Preview with cloud-docs local playbook (antora-playbook.local.yml)
  • Verify Savanna docs: nav, typography, page actions (copy Markdown)
  • Verify embedded video on database secret page renders with play overlay
  • Confirm Cloud Classic pages still render correctly

Introduce the theme-cloud stylesheet for Savanna and Cloud Classic, switch
docs typography to Inter, Outfit, and JetBrains Mono, refine navigation and
tabs, add page-level copy and view-in-LLM actions, and rebuild ui-bundle.zip.
Add videoblock.css and a 09-video-player.js click-to-play overlay, wire
videoblock.css into site.css, and rebuild build/ui-bundle.zip so the
theme ships the new video styling and behavior.
Remove the 760px cap so embedded videos use the full article column and
rebuild ui-bundle.zip for production.
@ngarakapati

Copy link
Copy Markdown
Contributor Author

@Tushar-TG-14 Please review this

@ngarakapati

Copy link
Copy Markdown
Contributor Author

Closing in favor of a contained approach: instead of merging the theme into the shared ui-bundle.zip (which all TigerGraph product docs consume), we'll ship a separate build/ui-bundle-cloud.zip artifact so the theme applies only to the Savanna + Cloud Classic docs (cloud-docs). A follow-up PR adding just the cloud bundle will replace this one.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant