-
-
Notifications
You must be signed in to change notification settings - Fork 21.4k
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Improve the top docs sections of VFX classes #78865
Improve the top docs sections of VFX classes #78865
Conversation
4792118
to
2f8b117
Compare
I would suggest separating the changes that fixes clear errors in the documentation from stylistic changes for easier reviewing |
cc @QbieShay @hpvb @winston-yallow I would appreciate your reviews of the content since you have been personally named. 🙃 |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thanks Mew for the works! Apologies i didn't catch these earlier.
Approval is for content, form to be left to doc team.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
looks good to me 🎉
I initially asked Yuri and he suggested I should split PRs based on area. I'll do this extra split if the docs team demands it, and I'll also do it for my following PRs. I did it like this because I categorized the changes in the post-processing step, after I finished the PR. |
2f8b117
to
935f127
Compare
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I left a few comments and tried to add suggestions wherever I thought an existing description should be improved.
Please let me know if you have any questions about my comments/suggestions!
f0b76eb
to
50f662e
Compare
50f662e
to
7153e51
Compare
7153e51
to
8ea2bf7
Compare
Feedback addressed again :) |
005b173
to
56ae025
Compare
56ae025
to
57d05ff
Compare
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Amazing work! The current iteration looks good to me. I think we should go ahead and merge this now so it doesn't get stalled forever.
In the future, I highly recommend batching changes into smaller PRs, this size of PR is very hard to review efficiently and thus gets pushed to the backburner for those of us doing reviews
Duly noted! |
Thanks! |
The top sections of classes are often one of the first things users read about them, so they are important to get right.
Improves the brief descriptions (mainly), main descriptions, and tutorial sections of many VFX-related classes (but not visual shader nodes). ShaderInclude docs was split off into its own thing and already merged.
Unlike my old posts, I've spent some time categorizing these by their importance, in case we want to nitpick.
Simple tweaks for consistency
[code]
tag where appropriate.Tweaked substantially, changed the flow of ideas
Doesn't fix a mistake, but still a tangible improvement
Fixes mistakes
Thanks a ton to Qbie, TMM, and Winston who helped with and workshopped for some of these changes in advance.