learn-build-service-prod[bot]
commented
7 months ago Learn Build status updates of commit 8ebf58f:
:white_check_mark: Validation status: passed
| File | Status | Preview URL | Details |
|---|---|---|---|
| microsoft-edge/toc.yml | :white_check_mark:Succeeded | View |
For more details, please refer to the build report.
For any questions, please:
- Try searching the learn.microsoft.com contributor guides
- Post your question in the Learn support channel
mikehoffms
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