High level docs #371
Merged
High level docs #371
Conversation
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
Document BlockDefinition resource and block types using GDScript documentation comments. Outside code, rename the current technical document to `docs/TECH_OVERVIEW.md` to indicate that it's technical. And update it: - Move "How to create a new block" to the top - Leave UI technical docs in its own section - Remove other outdated explanation It would be nice to also document the AST decouple from the UI, but I'm no expert to do it.
Improve editing the BlockDefinition resource in the Inspector: - Disable fields `variant_type` and `signal_name` when the block type doesn't correspond. - Remove `scope` from exports. This is handled internally by the `DragManager` so can be a regular variable.
Move it to `docs/USAGE.md`. Split general user guidelines into multiple sections. Document all Simple nodes that provide high-level abstraction blocks. Fix #365
|
I started writting docs for users, but also ended up updating and cleaning the outdated info for devs too. |
wjt
approved these changes
Jan 30, 2025
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.
Fix #365