Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Redesign WebView2 TOC & clarify article titles #3124

Open
wants to merge 60 commits into
base: main
Choose a base branch
from
Open

Conversation

mikehoffms
Copy link
Contributor

@mikehoffms mikehoffms commented Apr 9, 2024

Rendered articles for review:

  • WebView2 documentation (landing page)
  • TOC
    • toc.yml
      • To load latest .png files & TOC: F12 > right-click Refresh > Empty cache and hard refresh > F12.
    • Removed abstract TOC buckets ("Fundamentals", "Advanced") and directly/immediately shows their content.
      • Removed unnecessary levels of nesting.
      • Created "Introduction and overview" toc bucket.
      • Used tech-topic TOC bucket names. Promoted the tech key words users are looking for, and a generally flatter design that reveals more articles and specific topics by default.
      • Enabled more flexible grouping/placement of the articles.
      • Eliminated top-level buckets that are low-value & abstract; promotes the high-value, keyword-based nodes that were contained in them.
      • Eliminated a UX of guessing and having to explore into the abstract TOC nodes.
      • Made maintenance/improvement easier.
    • Group articles by tech topic (high-value grouping), not by some other, low-value quality such as info type or Fundamentals vs. Advanced.
      • Grouped together articles such as distribution.md & versioning.md that were spread apart between two different TOC buckets (Fundamentals & Deployment).
      • Within a tech-topic toc bucket, basic articles are first; advanced or specialized articles are last.
      • Instead of "Fund/Adv" buckets, an article's Intro helps user decide if article is relevant.
    • Improved titles of articles (globally in repo):
      • Changed "Sample apps" to "WebView2 sample apps".
      • Changed "Overview of WebView2 features and APIs" to "Overview of WebView2 APIs".
      • Changed "Working with local content in WebView2 apps" to "Using local content in WebView2 apps".
      • Changed "Interop of native-side and web-side code" to "Interop of native and web code".
      • Changed "Customizing the UI in WebView2 apps" to "Customizing the UI of WebView2 apps".
      • Changed "Deployment samples" to "WebView2 deployment samples".
  • Prerelease and Release SDKs for WebView2
  • Interop of native and web code

Mapping from existing TOC to redesigned TOC

image

History of PRs

This PR 3124 replaces forked July 2023 PR #2725, which lists the irrelevant file archive.md as entirely changed by that PR, yet not at all changed by that PR.

AB#50063950

@mikehoffms mikehoffms added in-progress cat: webview2 WebView-related content. labels Apr 9, 2024
@mikehoffms mikehoffms marked this pull request as ready for review April 10, 2024 23:50
@mikehoffms mikehoffms added on-hold The changes are currently on-hold and awaiting further evaluation. in-progress labels Apr 12, 2024
@mikehoffms mikehoffms marked this pull request as draft April 18, 2024 15:25
Copy link
Contributor Author

@mikehoffms mikehoffms left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM - Content Developer/Writer/Editor

Copy link

Learn Build status updates of commit 011789d:

✅ Validation status: passed

File Status Preview URL Details
microsoft-edge/develop-web-microsoft-edge.md ✅Succeeded View
microsoft-edge/developer/index.yml ✅Succeeded View
microsoft-edge/devtools-guide-chromium/experimental-features/index.md ✅Succeeded View
microsoft-edge/devtools-protocol-chromium/index.md ✅Succeeded View
microsoft-edge/extensions-chromium/samples.md ✅Succeeded View
microsoft-edge/index.yml ✅Succeeded View
microsoft-edge/playwright/index.md ✅Succeeded View
microsoft-edge/progressive-web-apps-chromium/how-to/service-workers.md ✅Succeeded View
microsoft-edge/puppeteer/index.md ✅Succeeded View
microsoft-edge/toc.yml ✅Succeeded View
microsoft-edge/web-platform/web-platform.md ✅Succeeded View
microsoft-edge/webdriver-chromium/capabilities-edge-options.md ✅Succeeded View
microsoft-edge/webdriver-chromium/contact.md ✅Succeeded View
microsoft-edge/webview2/code-samples-links.md ✅Succeeded View
microsoft-edge/webview2/concepts/data-privacy.md ✅Succeeded View
microsoft-edge/webview2/concepts/developer-guide.md ✅Succeeded View
microsoft-edge/webview2/concepts/environment-controller-core.md ✅Succeeded View
microsoft-edge/webview2/concepts/frames.md ✅Succeeded View
microsoft-edge/webview2/concepts/multi-profile-support.md ✅Succeeded View
microsoft-edge/webview2/concepts/navigation-events.md ✅Succeeded View
microsoft-edge/webview2/concepts/overview-features-apis.md ✅Succeeded View
microsoft-edge/webview2/concepts/process-related-events.md ✅Succeeded View
microsoft-edge/webview2/concepts/windowed-vs-visual-hosting.md ✅Succeeded View
microsoft-edge/webview2/concepts/working-with-local-content.md ✅Succeeded View
microsoft-edge/webview2/contact.md ✅Succeeded View

This comment lists only the first 25 files in the pull request.
For more details, please refer to the build report.

For any questions, please:

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
cat: webview2 WebView-related content.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant