Skip to content
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.

Sign up for GitHub

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

Jump to bottom

[Refactor] common.wgsl docs #35

Open
alphastrata opened this issue Oct 15, 2023 · 0 comments
Open

[Refactor] common.wgsl docs #35

alphastrata opened this issue Oct 15, 2023 · 0 comments
Labels
documentation Improvements or additions to documentation enhancement New feature or request good first issue Good for newcomers

Comments

@alphastrata
Copy link
Owner

what are we refactoring?
shader_utils/common.wgsl has many shader helper functions without docs.

  • All functions need docs
  • All functions need example usage (rust-doc style), or better yet, a shader showing their use in the assets/shaders/* dir, or maybe we use shadplay itself to make little markdown doc style explanations with images etc...

why?
Because the whole point of this project is to have nice docs that explain how to use things....
@alphastrata alphastrata added documentation Improvements or additions to documentation enhancement New feature or request good first issue Good for newcomers labels Oct 15, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
documentation Improvements or additions to documentation enhancement New feature or request good first issue Good for newcomers
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
1 participant
@alphastrata