Repository navigation
feat: polish WebUI documentation experience - #459
Merged
Mohamed Mansour (mohamedmansour) merged 3 commits intoAug 20, 2026
Merged
Mohamed Mansour (mohamedmansour) merged 3 commits into
Mohamed Mansour (mohamedmansour) merged 3 commits into
Conversation
Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com>
Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com>
Mohamed Mansour (mohamedmansour)
requested review from
Bang Lee (Qusic),
Akrosh Gandhi (akroshg),
Jane Chu (janechu) and
mcritzjam
and
a lite review from Copilot
August 20, 2026 14:23
Contributor
There was a problem hiding this comment.
Pull request overview
This PR improves the WebUI documentation site’s usability and reliability by moving navigation and chrome behavior into WebUI-native components, tightening accessibility semantics, refining layout/typography tokens, and hardening the Playground loading/recovery experience with added browser regression tests.
Changes:
- Replace DOM-mutation-based mobile navigation with
<docs-site-navigation>(native<dialog>) and<docs-sidebar-navigation>(native<details>), plus a skip-to-content link and improved heading semantics. - Improve docs styling for reading measure, tables, feature grid, tokens, and focus/hover behavior across desktop and mobile.
- Harden Playground failure states (retry flow, accessible labels) and expand Playwright coverage for navigation, hydration, and recovery.
Reviewed changes
Copilot reviewed 21 out of 21 changed files in this pull request and generated 3 comments.
Show a summary per file
| File | Description |
|---|---|
| docs/.webui-press/theme.css | Adjust brand/text tokens and gradients for improved contrast/readability. |
| docs/.webui-press/config.json | Restructure sidebar grouping and homepage feature iconography. |
| docs/.webui-press/components/docs-playground/docs-playground.ts | Add retryable WASM loading behavior and error-state refinements. |
| docs/.webui-press/components/docs-playground/docs-playground.html | Improve Playground accessibility semantics (buttons/labels/regions/iframe title) and add retry UI. |
| docs/.webui-press/components/docs-playground/docs-playground.css | Update tab UX, focus handling, mobile sizing, and error recovery styling. |
| crates/webui-press/template/index.ts | Swap to component-driven navigation and adjust anchor scrolling logic. |
| crates/webui-press/template/index.html | Integrate new navigation components, add skip link, and improve semantic heading structure. |
| crates/webui-press/template/docs.css | Reading-measure/layout refinements, improved tables/admonitions, and mobile header/page context updates. |
| crates/webui-press/template/docs-theme-toggle/docs-theme-toggle.css | Normalize header control sizing and mobile touch targets. |
| crates/webui-press/template/docs-site-navigation/docs-site-navigation.ts | New WebUI-native site navigation component; manages dialog + transition skipping. |
| crates/webui-press/template/docs-site-navigation/docs-site-navigation.html | New navigation markup with accessible dialog + mobile nav structure. |
| crates/webui-press/template/docs-site-navigation/docs-site-navigation.css | Styling for header navigation + mobile dialog panel. |
| crates/webui-press/template/docs-sidebar-navigation/docs-sidebar-navigation.html | New sidebar navigation markup using native disclosures. |
| crates/webui-press/template/docs-sidebar-navigation/docs-sidebar-navigation.css | Styling for sidebar navigation and disclosure affordances. |
| crates/webui-press/template/docs-search/docs-search.ts | Fix search lifecycle by attaching/removing global listeners appropriately. |
| crates/webui-press/template/docs-search/docs-search.test.ts | Add/expand Playwright regression tests for navigation, hydration, mobile, and Playground recovery. |
| crates/webui-press/template/docs-search/docs-search.css | Header control sizing + mobile behavior and search highlighting spacing. |
| crates/webui-press/src/markdown.rs | Add accessible labels for generated heading anchors + test coverage. |
| crates/webui-press/src/content.rs | Add expanded/current section sidebar state and full-layout metadata for nav links. |
| crates/webui-press/README.md | Document new docs chrome components + behavior details. |
| crates/webui-press/components/webui-blockquote/webui-blockquote.css | Align blockquote styling with updated docs surface treatments. |
💡 Configure MCP servers for context-aware, tailored reviews. Learn more in the docs.
Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com>
Copilot started reviewing on behalf of
Mohamed Mansour (mohamedmansour)
August 20, 2026 16:35
View session
mcritzjam
approved these changes
Aug 20, 2026
Mohamed Mansour (mohamedmansour)
merged commit Aug 20, 2026
ad376c6
into
microsoft:main
24 checks passed
Mohamed Mansour (mohamedmansour)
deleted the
mohamedmansour-craft-docs-site
branch
August 20, 2026 16:50
Mohamed Mansour (mohamedmansour)
added a commit
that referenced
this pull request
Aug 26, 2026
## Release Bumps WebUI to `0.0.26`. Previous release tag: `v0.0.25` ## Changes since `v0.0.25` Features: - Python hosts now have an official typed PyO3 renderer package with buffered, partial, template, token, and host-driven streaming APIs (feat: add official Python renderer package #453 by @mohamedmansour). - Progressive SSR can place transport-flushed streaming boundaries inside reusable components while preserving component ownership and continuation state (feat: support component-local streaming boundaries #460 by @mohamedmansour). - Components can defer compiler-owned hydration until interaction, with router preload handoff and a combined lazy-render policy (feat: add compiler-driven interaction hydration #485 by @mohamedmansour). - Builds can opt into global Light DOM CSS while preserving explicit authored Shadow roots and deterministic style closures (feat: make Light DOM a global CSS opt-in #429 by @mohamedmansour). - State projection supports application-owned TypeScript 7.0.2 while retaining the TypeScript 6 migration path (feat: support TypeScript 7 projection compilation #452 by @mohamedmansour). - WebUI Press supports layout-scoped compile-time named regions with fallback HTML, state, components, and scripts (feat(press): add compile-time named regions #484 by @mohamedmansour). - FAST v2 and v3 gain plugin-owned local and npm component discovery with validated FAST template transformation (feat: add plugin-owned FAST component discovery #378 by @janechu). Fixes: - Missing condition identifiers are treated as falsy before negation and logical evaluation, aligning SSR with the browser runtime (fix: negate missing condition paths correctly #449 by @mohamedmansour). - FAST route state now scales through escaped scalar kebab-case attributes shared by FAST v2 and v3 (fix: scale FAST route state with scalar attributes #450 by @janechu). - Dynamic Link-mode components wait for native stylesheet readiness across navigation and component assets, preventing unstyled flashes (fix: prevent dynamic component stylesheet flashes #454 by @mohamedmansour). - Authored component definitions defer whenever compiled template metadata has not arrived, including ordinary router navigation (fix: defer authored define() whenever template metadata is missing #461 by @mohamedmansour). - Client structural updates preserve authored order and sibling ownership for shared slots and raw HTML ranges (fix: preserve source order for shared structural slots #465 by @mohamedmansour, fix: preserve siblings around raw HTML updates #466 by @mohamedmansour). - Native-element attributes no longer leak into the local state of a later component (perf(handler): stop native attributes leaking into component state #469 by @mohamedmansour). - Templates-and-state-only SSR bootstrap payloads no longer require component style metadata (fix: allow SSR bootstrap without component styles #475 by @mohamedmansour). - The high-level Rust `serve_request` path now preserves complete render options, including CSP nonces, while sharing the same entry and request path with partial rendering (fix: forward CSP nonces through serve_request #488 by @mohamedmansour). - Projection compilation bounds source reads, excludes binary and unsupported-loader inputs from semantic analysis, and preserves deterministic cleanup under large esbuild graphs (fix: bound projection adapter source reads #489 by @mohamedmansour). - Router pending UI remains mounted through pre-commit work and settles at the synchronous DOM commit, with stale, aborted, and re-entrant navigation cleanup kept generation-safe (fix: settle router pending UI during navigation commits #491 by @mohamedmansour). Docs: - The documentation site adds accessible responsive navigation, improved reading layouts, stronger search behavior, and Playground recovery states (feat: polish WebUI documentation experience #459 by @mohamedmansour). - Slot-resolution implementation guidance now documents pre-order lookup, pending placement ownership, and marker handling (chore: clarify slot resolution comments #471 by @mohamedmansour). - Repeated `w-ref` behavior is now explicit: refs are scalar and the last wired occurrence wins, while stable authored IDs or item components provide identity-based lookup (chore: clarify repeated w-ref behavior #490 by @mohamedmansour). Maintenance: - Release and package policy metadata now constrains the transitive h2 advisory, uses SPDX NuGet licensing, and classifies publishing jobs correctly (chore: allow constrained h2 advisory #451 by @janechu, fix: use modern NuGet license metadata #457 by @janechu, chore: mark publishing jobs as release jobs #458 by @janechu). - The development and CI Rust toolchain is updated to 1.98 with the resulting warnings resolved (Update rust toolchain version and fix clippy warning #462 by @telecos). - Release builds use Thin LTO to retain cross-crate optimization with faster linking (perf: switch release builds to Thin LTO #464 by @mohamedmansour). - Handler and expression hot paths reduce attribute vtable calls, render lookup and scope allocations, and single-term condition overhead (perf(handler): centralize HTML attribute writing in ResponseWriter #467 by @mohamedmansour, perf(expressions): fast-path single-term conditions #470 by @mohamedmansour, perf(handler): reduce render lookup and scope allocations #472 by @mohamedmansour). - Node rendering can reuse immutable prepared-state snapshots and bounded per-route output capacity hints (perf(node): reuse prepared state across renders #477 by @mohamedmansour, perf: reuse Node render output capacity #478 by @mohamedmansour). - Framework hydration releases bootstrap data sooner and reduces allocations for bindings, empty hosts, and visible conditionals (perf: reduce framework hydration allocations #479 by @mohamedmansour, perf: release SSR bootstrap memory after hydration #480 by @mohamedmansour, perf: reduce empty template host overhead #482 by @mohamedmansour, perf: remove visible conditional anchors #483 by @mohamedmansour). - Benchmark tooling now renders the full contact workload, runs Criterion baselines per target, and restores the streaming hydration fixture (fix(bench): render contacts in contact-book benchmark #468 by @mohamedmansour, fix(xtask): run Criterion benchmarks per target #473 by @mohamedmansour, fix: repair streaming hydration benchmark fixture #476 by @mohamedmansour). ## Validation - `cargo xtask check` --------- Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.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.
Why
The documentation site had broken mobile navigation, weak accessibility semantics, dense reading layouts, and a Playground route that could remain visually blank during cross-document navigation. This update makes the docs easier to read and operate across desktop and mobile while using WebUI's own component model for the interactive shell.
What changed
Validation
cargo xtask checkpnpm --filter @webui/webui-press testReview note
Full-layout pages intentionally skip the normal documentation crossfade. Chromium can otherwise keep the transition active while a viewport-filling custom page initializes, visually hiding content that is already present and hydrated.