docs: rework documentation#238
Merged
Merged
Conversation
andreiltd
force-pushed
the
docs
branch
29 times, most recently
from
e7bf7b7 to
1e2fd03
Compare
vados-cosmonic
approved these changes
Jul 11, 2025
Contributor
vados-cosmonic
left a comment
vados-cosmonic
left a comment
There was a problem hiding this comment.
LGTM 🚀
I have a bunch of comments but none of them are blocking -- the value of this improvement in documentation is massive. Happy to have this PR go in as-is, but felt I should at least leave some nits worth thinking about.
andreiltd
force-pushed
the
docs
branch
13 times, most recently
from
dcb3c34 to
3e68a4b
Compare
tschneidereit
approved these changes
Jul 21, 2025
Member
tschneidereit
left a comment
tschneidereit
left a comment
There was a problem hiding this comment.
This is really really fantastic, thank you so much!
I left a bunch of comments and suggestions, but none of them should hold up landing this whenever you feel ready to do so.
Co-authored-by: Till Schneidereit <till@tillschneidereit.net>
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
3 participants
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 patch splits documentation into multiple markdown files and deploys
mdbookto github pages. There are also new sections like developing builtins in c++.The rendered mdbook can be found here: https://andreiltd.github.io/StarlingMonkey/