IA-v2: Sidebar reshuffle + scenarios/ rename + Concepts + Embed topics#707
Open
brianlagunas wants to merge 2 commits into
Open
IA-v2: Sidebar reshuffle + scenarios/ rename + Concepts + Embed topics#707brianlagunas wants to merge 2 commits into
brianlagunas wants to merge 2 commits into
Conversation
…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>
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
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
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
webSidebararound 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,.rdashfiles, 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
Redirects added
/web/editing-dashboards→/web/scenarios(target updated to follow rename)Cross-links updated
editor-events.md(EN + JA): link tocustomizing/index.md→scenarios/index.mdKnown follow-ups (per the rewritten IA-v2 plan)
IRVDashboardProviderfrom Loading/Saving into a dedicated Dashboard Provider topic under Connect Datamaximizing-visualizations.md(its content is in Embed a Single Visualization)Test plan
npm run buildpasses for bothenandjalocales/web/customizing/view-only-embed/still resolves (page accessible at new path)/web/editing-dashboards/redirects to/web/scenarios/singleVisualizationMode+maximizedVisualizationinteraction)🤖 Generated with Claude Code