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

Redesigned WebView2 TOC #2725

Closed

Conversation

mikehoffms
Copy link
Contributor

@mikehoffms mikehoffms commented Jul 21, 2023

April 9, 2024: Closing this PR without Merging, to avoid History corruption. This PR wrongly lists "archive.md" (due to GitHub bug) as entirely changed by this PR, yet not changed; kept identical. So, created fresh PR #3124 that doesn't have archive.md listed in Files Changed.

Rendered TOC for review:
https://review.learn.microsoft.com/microsoft-edge/webview2/?branch=pr-en-us-2725
Before:
https://learn.microsoft.com/microsoft-edge/webview2/

Oct 11 note: PR 2856 creates TOC bucket, "Test and automation in WebView2 apps". Resulting TOC bucket:
https://learn.microsoft.com/microsoft-edge/webview2/how-to/set-preview-channel

  • Merged "main" into present PR to integrate that change.

Objectives of this TOC redesign:

  • Removes abstract TOC buckets ("Fundamentals", "Advanced") and directly/immediately shows their content.
    • Uses more topical, specific TOC buckets, and a generally flatter design that reveals more articles and specific topics by default.
    • Enables more flexible grouping/placement of the articles.
    • Eliminates a guessing/ hiding/ exploration-demanding/ discovery UX.
    • Makes maintenance/improvement easier.
  • Groups together articles such as distribution.md & versioning.md that were spread apart between two different TOC buckets (Fundamentals & Deployment). Within any topical TOC bucket, articles about basics are first, and advanced/specialized articles are below them.
  • Instead of mixing two different schemes for the TOC (group by topic vs. group by Fundamentals/Advanced), the new design uses only a single scheme: group by topic.

This PR also makes the following changes:

This TOC redesign is moved out from the Diagrams PR #2450, to simplify and focus that PR, and to expedite publishing this TOC redesign.

Mapping from existing TOC (left) to redesigned TOC (right):
image

@mikehoffms mikehoffms marked this pull request as ready for review July 21, 2023 20:02
microsoft-edge/toc.yml Outdated Show resolved Hide resolved
@mikehoffms mikehoffms added the cat: webview2 WebView-related content. label Jul 31, 2023
@learn-build-service-prod

This comment was marked as outdated.

@learn-build-service-prod

This comment was marked as outdated.

@learn-build-service-prod

This comment was marked as outdated.

@learn-build-service-prod

This comment was marked as outdated.

@learn-build-service-prod

This comment was marked as outdated.

@mikehoffms
Copy link
Contributor Author

Closing PR without merging.

@mikehoffms mikehoffms closed this Dec 15, 2023
@mikehoffms mikehoffms reopened this Feb 6, 2024
@mikehoffms mikehoffms changed the title Redesigned WebView2 TOC Redesigned WebView2 TOC (July 2023, based on fork) Feb 6, 2024
@mikehoffms mikehoffms marked this pull request as draft February 6, 2024 23:15
@mikehoffms mikehoffms marked this pull request as ready for review February 7, 2024 17:47
@mikehoffms mikehoffms changed the title Redesigned WebView2 TOC (July 2023, based on fork) Redesigned WebView2 TOC Feb 22, 2024
Copy link

Learn Build status updates of commit 3dee258:

✅ Validation status: passed

File Status Preview URL Details
microsoft-edge/toc.yml ✅Succeeded View
microsoft-edge/webview2/concepts/frames.md ✅Succeeded View
microsoft-edge/webview2/concepts/overview-features-apis.md ✅Succeeded View
microsoft-edge/webview2/concepts/versioning.md ✅Succeeded View
microsoft-edge/webview2/how-to/communicate-btwn-web-native.md ✅Succeeded View
microsoft-edge/webview2/how-to/set-preview-channel.md ✅Succeeded View
microsoft-edge/webview2/release-notes.md ✅Succeeded View
microsoft-edge/webview2/samples/webview2apissample.md ✅Succeeded View

For more details, please refer to the build report.

For any questions, please:

Copy link

Learn Build status updates of commit aba9676:

✅ Validation status: passed

File Status Preview URL Details
microsoft-edge/toc.yml ✅Succeeded View
microsoft-edge/webview2/concepts/frames.md ✅Succeeded View
microsoft-edge/webview2/concepts/overview-features-apis.md ✅Succeeded View
microsoft-edge/webview2/concepts/versioning.md ✅Succeeded View
microsoft-edge/webview2/how-to/communicate-btwn-web-native.md ✅Succeeded View
microsoft-edge/webview2/how-to/set-preview-channel.md ✅Succeeded View
microsoft-edge/webview2/release-notes.md ✅Succeeded View
microsoft-edge/webview2/samples/webview2apissample.md ✅Succeeded View

For more details, please refer to the build report.

For any questions, please:

Copy link

Learn Build status updates of commit 49f8070:

✅ Validation status: passed

File Status Preview URL Details
microsoft-edge/toc.yml ✅Succeeded View
microsoft-edge/webview2/concepts/frames.md ✅Succeeded View
microsoft-edge/webview2/concepts/overview-features-apis.md ✅Succeeded View
microsoft-edge/webview2/concepts/versioning.md ✅Succeeded View
microsoft-edge/webview2/how-to/communicate-btwn-web-native.md ✅Succeeded View
microsoft-edge/webview2/how-to/set-preview-channel.md ✅Succeeded View
microsoft-edge/webview2/release-notes/archive.md ✅Succeeded View
microsoft-edge/webview2/samples/webview2apissample.md ✅Succeeded View

For more details, please refer to the build report.

For any questions, please:

@mikehoffms
Copy link
Contributor Author

Closing this PR without Merging, to avoid History corruption. This PR wrongly lists "archive.md" (due to GitHub bug) as entirely changed by this PR, yet not changed; kept identical. So, created fresh PR #3124 that doesn't have archive.md listed in Files Changed.

@mikehoffms mikehoffms closed this Apr 11, 2024
@mikehoffms mikehoffms deleted the user/mikehoffms/toc-wv2 branch April 11, 2024 00:57
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.

2 participants