doc: Add an introduction and a design overview to the user guide #674
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
And provide stubs for the How-Tos on parsing/navigating the syntax tree.
|
Xanewok
commented
Nov 24, 2023
AntonyBlakey
suggested changes
Nov 27, 2023
|
Updated! |
OmarTawfik
reviewed
Nov 28, 2023
OmarTawfik
reviewed
Nov 28, 2023
OmarTawfik
reviewed
Nov 28, 2023
OmarTawfik
reviewed
Nov 28, 2023
OmarTawfik
reviewed
Nov 28, 2023
OmarTawfik
reviewed
Nov 28, 2023
OmarTawfik
reviewed
Nov 28, 2023
documentation/public/user-guide/rust-crate/how-to-parse-a-file.md
Outdated
Show resolved
Hide resolved
OmarTawfik
reviewed
Dec 1, 2023
OmarTawfik
approved these changes
Dec 1, 2023
|
@AntonyBlakey I believe this is still blocked on your re-review |
AntonyBlakey
approved these changes
Dec 3, 2023
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.
In preparation for #334 (and other how-tos).
This adds a bit more introduction and context to the user guide that should be independent on the actual API used (Rust/TS) and also provides stubs for the How-Tos on the parsing/navigating the syntax tree.
When I tried to write these specific how-tos, I thought that we should be able to define, at least from the higher level, what the CST is, how the process looks like and add some more context (e.g. multiple versions and why we need to create a specific version for the language, first). Also this helps establish a bit more structure to the guide that should help with writing more documentation/guides as we go.
Ironically, http://shader-slang.com/slang/user-guide/index.html helped me structure this a bit as a guide that the user is welcomed to and what they might benefit from (intro, context) before diving deeper into the guides/context.