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 (Feb. 2024) #3047

Closed
wants to merge 1 commit into from

Conversation

mikehoffms
Copy link
Contributor

@mikehoffms mikehoffms commented Feb 6, 2024

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

Copy link

Learn Build status updates of commit 8ebf58f:

✅ Validation status: passed

File Status Preview URL Details
microsoft-edge/toc.yml ✅Succeeded View

For more details, please refer to the build report.

For any questions, please:

@mikehoffms mikehoffms added the cat: webview2 WebView-related content. label Feb 6, 2024
@mikehoffms mikehoffms marked this pull request as draft February 6, 2024 23:43
@mikehoffms
Copy link
Contributor Author

Use orig. PR instead:
PR 2725 (Redesigned WebView2 TOC) (July 2023)

@mikehoffms mikehoffms closed this Feb 22, 2024
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