Skip to content

IA-v2: Sidebar reshuffle + scenarios/ rename + Concepts + Embed topics#707

Open
brianlagunas wants to merge 2 commits into
docs-ia-v2from
ia-v2/scenario-led-sidebar
Open

IA-v2: Sidebar reshuffle + scenarios/ rename + Concepts + Embed topics#707
brianlagunas wants to merge 2 commits into
docs-ia-v2from
ia-v2/scenario-led-sidebar

Conversation

@brianlagunas
Copy link
Copy Markdown
Member

@brianlagunas brianlagunas commented May 16, 2026

Summary

Bundles three related changes that together shift the Web SDK docs onto the new scenario-led IA:

1. Sidebar reshuffle to scenario-led IA

Restructures webSidebar around customer goals (per industry convention from Tableau, Power BI, Sisense, ThoughtSpot, QuickSight, Looker). Reveal's previous feature-bucket IA was the outlier.

New top-level groups: Get Started → Embedding → Common Patterns → Connect Data → Export and Share → Server Configuration → Reference → Releases. The "Customizing the Reveal View" group dissolves; "Visualizations" dissolves (members go to Reference). Existing pages slot into transitional positions awaiting per-page rewrite.

2. Folder rename: customizing/scenarios/

"Customizing" was too narrow once Common Patterns grew to cover non-customization scenarios. "scenarios" is generic and future-proof. EN + JA. Common Patterns promoted to top-level.

3. New foundational topics

  • docs/web/concepts.md — mental model for client/server split, .rdash files, the four provider interfaces, and how a request flows through the SDK. Read once; the rest of the docs assume this vocabulary.
  • docs/web/embedding/dashboard.md — canonical "embed a full dashboard" topic. Minimum code, variations, what's-next links into Common Patterns.
  • docs/web/embedding/single-visualization.md — net-new content (was a documented gap). Covers Single Visualization Mode (locked) and Maximized Visualization (with navigation), plus dynamic switching.

Sidebar after this PR

Get Started
├── Overview
├── Concepts                    (NEW)
├── Installation (sub-cat)
├── Quickstart — Server (sub-cat)
└── Quickstart — Client (sub-cat)

Embedding
├── Embed a Dashboard           (NEW — canonical)
├── Embed a Single Visualization (NEW — canonical)
├── Loading                     (transitional)
├── Creating                    (transitional)
└── Saving                      (transitional)

Common Patterns                 (top-level, was sub-cat)
├── Read-only Embed
├── Editor on Load (Kiosk)
├── Custom Save Destination
├── Locked-down Export Menu
├── Filtering, Linking, Click Events,
    Theming, Localization       (transitional, awaiting scenario rewrite)

Connect Data
Export and Share
Server Configuration
Reference (incl. Editor Events, Custom Visualizations,
           Custom Menu Items, Customizing Map Tiles,
           Tooltips, Maximizing, Chart Types as feature topics)
Releases

Redirects added

  • /web/editing-dashboards/web/scenarios (target updated to follow rename)

Cross-links updated

  • editor-events.md (EN + JA): link to customizing/index.mdscenarios/index.md

Known follow-ups (per the rewritten IA-v2 plan)

Test plan

  • npm run build passes for both en and ja locales
  • Verified /web/customizing/view-only-embed/ still resolves (page accessible at new path)
  • Verified /web/editing-dashboards/ redirects to /web/scenarios/
  • Concepts page links validated: install pages, embedding pages, scenarios overview, datasources
  • Reviewer to walk every entry in the new sidebar locally
  • Reviewer to read Concepts page top-to-bottom and confirm the mental model is accurate
  • Reviewer to flag any technical inaccuracies in Embed a Dashboard / Embed a Single Visualization (especially the singleVisualizationMode + maximizedVisualization interaction)

🤖 Generated with Claude Code

brianlagunas and others added 2 commits May 15, 2026 21:33
…arios/

Restructures the Web SDK sidebar around customer goals (per industry
convention from Tableau, Power BI, Sisense, ThoughtSpot, QuickSight,
Looker). The previous feature-bucket IA (Dashboards / Visualizations /
Customizing the Reveal View) dissolves; existing pages slot into their
future homes as transitional placeholders awaiting per-page migration
in upcoming sub-PRs.

New top-level groups:
- Get Started     (unchanged)
- Embedding       (Loading/Creating/Saving as transitional; will merge
                   into Embed a Dashboard + Embed a Single Visualization)
- Common Patterns (top-level — promoted from Customizing sub-cat. Holds
                   the 4 existing scenarios + 5 transitional feature pages
                   awaiting scenario rewrite: Filtering, Linking, Click
                   Events, Theming, Localization)
- Connect Data    (renamed from "Working with Data Sources"; unchanged)
- Export and Share (renamed from "Exporting"; unchanged)
- Server Configuration (unchanged)
- Reference       (Editor Events, Custom Visualizations, Custom Menu
                   Items, Customizing Map Tiles, Tooltips, Maximizing,
                   Chart Types — feature topics that are reference-shaped.
                   Plus Data Limits, Beta Features, Accessibility, Known
                   Issues, Third-Party Software.)
- Releases        (unchanged)

The "Customizing the Reveal View" group dissolves entirely.
Visualizations dissolves; its members go to Reference (or migrate to
scenarios in later PRs).

Folder rename: docs/web/customizing/ → docs/web/scenarios/ (EN + JA).
"Customizing" was too narrow once Common Patterns grew to cover non-
customization scenarios (read-only embed, multi-dashboard navigation,
drill-through). "scenarios" is generic and future-proof.

Redirects added for all 5 customizing/* paths and the customizing/ root.
The /web/editing-dashboards redirect target updated from /web/customizing
to /web/scenarios.

Cross-link in editor-events.md (EN + JA) updated to point at new path.

Known follow-ups (per IA-v2 plan):
- Sub-PR #2: Concepts page
- Sub-PR #3: Embed a Dashboard + Embed a Single Visualization (replaces
  Embedding section's transitional Loading/Creating/Saving)
- Sub-PRs #4-7: Migrate Click Events, Filtering, Linking, Theming,
  Localization to proper Common Patterns scenarios
- Sub-PRs #10-12: Multi-Tenant, RLS, Custom Viz Library Solutions guides

Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
Three foundational topics for the new IA:

- docs/web/concepts.md — mental model for client/server split, .rdash
  files, the four provider interfaces, and how a request flows through
  the SDK. Read once; the rest of the docs assume this vocabulary.

- docs/web/embedding/dashboard.md — the canonical "embed a full
  dashboard" topic. Minimum code, variations (new empty dashboard, JSON
  source, embedded resource), and what's-next links into Common
  Patterns scenarios. Replaces the role of Loading/Creating as the
  primary embedding starting point.

- docs/web/embedding/single-visualization.md — net-new content (was a
  documented gap). Covers Single Visualization Mode (locked) and
  Maximized Visualization (with navigation), plus dynamic switching
  between visualizations.

Sidebar:
- Concepts added under Get Started, right after Overview.
- Embedding section now leads with the two new Embed topics. Loading,
  Creating, Saving remain below as transitional pages — they cover
  server-side IRVDashboardProvider patterns that move to a dedicated
  Dashboard Provider topic under Connect Data in a later sub-PR.

JA placeholders mirrored for all three new pages.

Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
@brianlagunas brianlagunas changed the title IA-v2: Scenario-led sidebar reshuffle + rename customizing/ to scenarios/ IA-v2: Sidebar reshuffle + scenarios/ rename + Concepts + Embed topics May 16, 2026
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