Skip to content

Modernize docgen: Bootstrap 5.3.8, drop jQuery/Font Awesome, add centralized mega menu#863

Merged
stevespringett merged 6 commits intomasterfrom
doc-updates
Mar 10, 2026
Merged

Modernize docgen: Bootstrap 5.3.8, drop jQuery/Font Awesome, add centralized mega menu#863
stevespringett merged 6 commits intomasterfrom
doc-updates

Conversation

@stevespringett
Copy link
Member

Summary

Modernizes the documentation generation pipeline across all three template systems (JSON/Jinja2, XML/XSLT, Proto/Go).

Dependency upgrades

  • Bootstrap: 3.4.1 (XML) and 4.6.2 (JSON, Proto) → 5.3.8
  • jQuery: Removed entirely — all JS rewritten to vanilla DOM APIs
  • Font Awesome 4.7: Replaced with Bootstrap Icons 1.11.3
  • markdown-it: Removed (unused dependency in JSON templates)

Protobuf documentation overhaul

  • Restructured to match JSON docs in look, feel, and navigation behavior
  • Updated CSS for consistent styling with JSON and XML docs

Centralized mega menu and header injection

  • docgen/static/releases.json — single source of truth for all version metadata
  • docgen/static/generate-menu.py — builds mega menu HTML from JSON data
  • docgen/static/header.html — shared header with navbar, mega menu, backdrop overlay, and interaction logic
  • docgen/static/inject-header.sh — post-processing pipeline that assembles and injects the header into generated docs
  • Replaces per-template hardcoded version dropdowns with a shared, data-driven mega menu
  • Supports featured releases, optional formats, ECMA standard references, and skip flags
  • Format pills are native <a> tags (SEO-friendly, visible in browser status bar)
  • Responsive breakpoints
  • Backdrop overlay, Escape key, and click-outside dismiss the menu

Preview

Screenshot 2026-03-09 at 8 20 08 PM Screenshot 2026-03-09 at 8 20 19 PM Screenshot 2026-03-09 at 8 20 31 PM Screenshot 2026-03-09 at 8 21 06 PM Screenshot 2026-03-09 at 8 21 25 PM

Signed-off-by: Steve Springett <steve@springett.us>
Signed-off-by: Steve Springett <steve@springett.us>
@stevespringett stevespringett requested a review from a team as a code owner March 10, 2026 01:23
Signed-off-by: Steve Springett <steve@springett.us>
stevespringett and others added 3 commits March 9, 2026 20:33
Signed-off-by: Steve Springett <steve@springett.us>
…in path expression

Co-authored-by: Copilot Autofix powered by AI <62310815+github-advanced-security[bot]@users.noreply.github.com>
Signed-off-by: Steve Springett <steve@springett.us>
@stevespringett stevespringett merged commit 1886816 into master Mar 10, 2026
15 checks passed
@stevespringett stevespringett deleted the doc-updates branch March 10, 2026 15:36
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