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

Skip h3 in all files in repo, to show main structure of articles #3232

Merged
merged 18 commits into from
Sep 24, 2024

Conversation

mikehoffms
Copy link
Contributor

@mikehoffms mikehoffms commented Jul 22, 2024

Rendered articles for review:

This PR makes the following changes:

  • Applied h2/h4/h6 pattern to remaining files in repo, so that no files in repo use h3.
    • h3 is rendered very nearly the same size as h2, so converted h3 to h4.
      • h3 is rendered too close in size to h2, making the article's main outline structure imperceptible.
      • "In this article" nav omits to show the h2/h3 outline, so this is extra important - esp for h3.
    • In files that used h3, converted existing h4 to h6.
    • Repo contains 0 h3's.
    • Above headings, consistently used repo's standard divider comments, specific to each heading level, to make source files consistent & readable, for maintainability.
    • Repo contains 0 h5's except for tabsets.
      • Changed h1 tabs to h5 tabs, for consistency.
      • Changed * * * end-tabset demarcators to ---, for consistency.
  • In some files, improved link wording/tagging/urls.
    • Added See also h2, listing all links from article. That process revealed the following issue to fix:
    • Updated link url or updated link text to match destination title|heading.
    • Clarified link text & destination site by applying best practices for links wording & tagging.
    • Removed excessive linking of every mention of a thing, for better maintainability & readability.
  • In some files, removed alerts formatting (Note, Tip), deprecated per corp tagging guide. Changed some to a heading.

AB#52705164

@mikehoffms mikehoffms marked this pull request as ready for review September 16, 2024 16:41
@mikehoffms mikehoffms changed the title Skip h3 Skip h3 in all files in repo, to make main structure of articles perceptible Sep 16, 2024
@mikehoffms mikehoffms changed the title Skip h3 in all files in repo, to make main structure of articles perceptible Skip h3 in all files in repo, to show main structure of articles Sep 16, 2024
Copy link

Learn Build status updates of commit 6ef1062:

✅ Validation status: passed

File Status Preview URL Details
microsoft-edge/accessibility/build/index.md ✅Succeeded View
microsoft-edge/devtools-guide-chromium/accessibility/navigation.md ✅Succeeded View
microsoft-edge/devtools-guide-chromium/accessibility/test-issues-tool.md ✅Succeeded View
microsoft-edge/devtools-guide-chromium/accessibility/test-tab-key-source-order-viewer.md ✅Succeeded View
microsoft-edge/devtools-guide-chromium/console/api.md ✅Succeeded View
microsoft-edge/devtools-guide-chromium/console/console-debug-javascript.md ✅Succeeded View
microsoft-edge/devtools-guide-chromium/console/index.md ✅Succeeded View
microsoft-edge/devtools-guide-chromium/console/live-expressions.md ✅Succeeded View
microsoft-edge/devtools-guide-chromium/css/reference.md ✅Succeeded View
microsoft-edge/devtools-guide-chromium/device-mode/dual-screen-and-foldables.md ✅Succeeded View
microsoft-edge/devtools-guide-chromium/experimental-features/index.md ✅Succeeded View
microsoft-edge/devtools-guide-chromium/inspect-styles/animations.md ✅Succeeded View
microsoft-edge/devtools-guide-chromium/media-panel/index.md ✅Succeeded View
microsoft-edge/devtools-guide-chromium/memory-inspector/memory-inspector-tool.md ✅Succeeded View
microsoft-edge/devtools-guide-chromium/memory-problems/index.md ✅Succeeded View
microsoft-edge/devtools-guide-chromium/network/index.md ✅Succeeded View
microsoft-edge/devtools-guide-chromium/remote-debugging/index.md ✅Succeeded View
microsoft-edge/devtools-guide-chromium/remote-debugging/local-server.md ✅Succeeded View
microsoft-edge/devtools-guide-chromium/remote-debugging/surface-duo-emulator.md ✅Succeeded View
microsoft-edge/devtools-guide-chromium/remote-debugging/webviews.md ✅Succeeded View
microsoft-edge/devtools-guide-chromium/remote-debugging/windows.md ✅Succeeded View
microsoft-edge/devtools-guide-chromium/rendering-tools/js-runtime.md ✅Succeeded View
microsoft-edge/devtools-guide-chromium/shortcuts/index.md ✅Succeeded View
microsoft-edge/devtools-guide-chromium/whats-new/2019/12/devtools.md ✅Succeeded View
microsoft-edge/devtools-guide-chromium/whats-new/2020/01/devtools.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:

@captainbrosset captainbrosset merged commit cef574b into main Sep 24, 2024
2 checks passed
@captainbrosset captainbrosset deleted the user/mikehoffms/skip-h3 branch September 24, 2024 09:39
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
cat: general General content.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants