docs(asynchronous-work): fix misaligned event loop ASCII diagram and add warning for changes to diagram alignment#78
Conversation
…add note about future changes to check live page preview Fix the misaligned diagram spacing and alignment of components. Add a HTML comment to the event loop phase diagram to clarify that the source alignment is intentional for correct HTML rendering. This prevents accidental misalignment by future contributors.
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
PR SummaryLow Risk Overview Adds an HTML comment above the diagram telling contributors the raw markdown may look off while still rendering correctly live, and to avoid “fixing” alignment in source unless the live page is actually broken. Reviewed by Cursor Bugbot for commit 5f8dba7. Bugbot is set up for automated code reviews on this repo. Configure here. |
👋 Codeowner Review RequestThe following codeowners have been identified for the changed files: Team reviewers: @nodejs/timers Please review the changes when you have a chance. Thank you! 🙏 |
|
What browser? This looks broken for me in Chrome 
|
|
That is weird, it may be a cached version in your browser but it looks like you're testing it in incognito where it shouldn't. I also tested it on all 4 of these browsers: chrome guest window, brave, edge and firefox dev edition private window. It looks fine across all, so it could be just outdated on your end. Would you be able to give it another look on a different browser on your end? This is the browser version info I tested against. @mikeesto Chrome: 
Brave: 
Edge: 
Firefox: 
Browser Version Infos
|
|
Hmm, weird. It still looks broken for me on Chrome (Version 148.0.7778.179 (Official Build) (arm64)). I tried incognito and disabling browser cache too. Perhaps just a problem on my end though! Let's see what others say |
2 participants
Summary
This PR adjusts the event loop ASCII diagram in the markdown source so its spacing and alignment render correctly on the live docs page.
Changes
pages/asynchronous-work/event-loop-timers-and-nexttick.mdto reflect proper alignmentWhy
The event loop diagram is whitespace-sensitive, and small formatting changes can make it look misaligned in source or in the rendered page. This change preserves the intended layout and documents that behavior for future contributors. Without this note, there is a risk that well-intentioned contributors might attempt to "fix" the alignment in the
.mdfile, which would actually break the visual layout for end-users.This note serves as a safeguard to preserve the correct live rendering.
Verification
Current View:
Fixed View: