docs: Internals Book improvements (01) - #23368
Open
NickSdot wants to merge 2 commits into
Open
Conversation
This was referenced Aug 19, 2026
NickSdot
marked this pull request as ready for review
August 19, 2026 12:08
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
This is switching the internals book to Markdown. The PR is formatting only and deliberately:
Why Markdown?
docs-oldcleanThis is a preflight in preparation for:
until here it was more or less mechanical changes; they should be seen as preparation for the following 3 that change actual old contents.
The work is split into multiple PRs to keep diffs comparable and focused; without splitting them git would mark quite literally everything as deleted and new files.
Preview
Branch: https://nicksdot.github.io/docs-restructure-01/
Final: https://nicksdot.github.io/docs-restructure-final/
Aside
I got multiple times asked to split my PRs into multiple smaller PRs. But I also got approached and told that it is annoying. Hence, I'd like to address that quick. Here splitting is essential because with the many moves and content changes in one PR the diff would simply not be reviewable. My serial PRs were needed because things either depended strongly on each other or touched too many files/extensions for one PR. That said, I consider the work that I have been doing over the last few weeks as "groundwork"; after this one I should be done with the bigger changes. So please kindly bear with me. :)
Related
#13338 (#13338 (comment))
#15939
#15940
#17761
#18409