docs: Add architecture doc #919
Open
Conversation
This file contains 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
✅ Deploy Preview for rolldown-rs canceled.
|
|
Nice! |
|
Don't worry about the conflicts. I need some time to adjust the content. Once it's done, I' ll solve the conflict and merge it. |
|
Thanks @hyf0, I'm happy to take any feedback too and make adjustments, whatever is more convenient for you. |
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.
Description
This PR adds an Architecture doc. The purpose of this doc is to describe the high level architecture of the rolldown crate.
(ignore the script src at the top)
Notably, this PR adds a Mermaid component to the documentation site. This has a client-side rendering requirement, which might be undesirable. An alternative approach could be to render the mermaid diagrams to SVG at build time, and link to the pre-built images for the production build, as suggested in this comment to a similar issue.
This document is not complete, but rather a starting point which should be built on. There are still many parts of the rolldown code which are not clear to me and could be better explained. I'm choosing to open the PR now to get preliminary feedback from maintainers on the style and content of this doc. I'm not convinced this document is at a level of maturity that it adds value to this project. I have no ego attached to this and fully respect the decision to close this PR rather than merge it.