Redesigned WebView2 TOC (Feb. 2024) #3047
Closed
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.
I hope this PR ends up being closed-without-merging, and the orig. PR is used instead.
Rendered doc-set, to review TOC (/microsoft-edge/toc.yml):
Previous version of redesign (PR Closed w/o Merging):
If you view multiple rendered PRs at about the same time, such as Live & Prototype A & Prototype B, you must use separate browser windows, and watch the Address bar URL. Press Ctrl+F5 = Hard Refresh. Else you will see TOC from other PR or main/live branch. Extreme way: Edge > Settings > Privacy > Clear browsing data.
TOC design concepts:
Avoid TOC bucket names that are abstract, low-value, wildcards, and that obscure what's in them, a random guessing game. eg: "Conceptual articles", "Fundamentals", "Advanced". Beware a bucket name that lacks the key words that are in the titles of the articles.
Use TOC bucket names that contain specific technology key words, high-value, that match the key words of the titles of the articles that are in the bucket. eg "Debug", "Best practices". Bucket name should hint via key words, what article titles are contained in it.
Look for articles that have similar key words in title but are spread far apart in TOC - make them adjacent siblings. Don't use a TOC bucket to convey "advanced"; convey "advanced" by putting article last in bucket. Explicitly say Advanced in first paragraph of article; eg "Most WebView2 developers don't need to read this article."
Group articles by key word or technology topic, not by other, low-value attributes, such as level of importance, sequence of usage, or article type. Users need articles grouped together primarily by technology topic, as the highest-value grouping.
Per Info Architecture team, avoid deep nesting. Go for more articles per bucket. Prefer flatter nesting.
AB#48878070