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.

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

[Docs] Manual improvement suggestions #56

Open
21 tasks
VaclavElias opened this issue Oct 19, 2023 · 0 comments
Open
21 tasks

[Docs] Manual improvement suggestions #56

VaclavElias opened this issue Oct 19, 2023 · 0 comments
Labels
documentation Improvements or additions to documentation enhancement New feature or request good first issue Good for newcomers help wanted Extra attention is needed p2 High priority, or is required as a base for other things

Comments

@VaclavElias
Copy link
Collaborator

VaclavElias commented Oct 19, 2023

  • Code-only Resource Creation:
    • Textures: Described issues include loading and composing textures, modifying pixels, creating a 2D array from images, and rescaling.
    • Material: There's a need for documentation on creating a shader material from code.
    • Shaders: Simple examples for vertex and compute shaders are requested.
    • Entities: Documentation regarding entity management, dynamic creation, and disposal is needed.
  • Convenience Methods:
    • Mentioned the need for convenience methods to work with and convert between Int3, Vector3, and other vector-like types.
  • Struct Naming Confusion:
    • Pointed out too many similarly named structs across different packages like Color 8 and Vector 6.
  • GraphicsDevice and CommandLists Usage:
    • Found confusing the usage of GraphicsDevice and CommandLists as sometimes they are required but sometimes not in other overloads.
  • Mesh Instancing:
    • Highlighted a need for documentation on mesh instancing with colliders.
  • Multi-Camera / SplitScreen Setup:
    • Requested documentation for setting up multi-camera or split-screen.
  • UI Components:
    • Documentation on UI components is found lacking.
  • Lifetime of Arrays:
    • Mentioned uncertainty regarding the lifetime of arrays used in the creation of resources, especially regarding the safety of APIs grabbing a fixed pointer to an array.
  • Searchability Issues:
    • Mentioned difficulty in finding information due to the name "Stride" being common and having to modify search queries to "Stride engine" to get relevant results.

References

@VaclavElias VaclavElias added documentation Improvements or additions to documentation enhancement New feature or request help wanted Extra attention is needed good first issue Good for newcomers labels Oct 19, 2023
@VaclavElias VaclavElias changed the title Document suggestions [Docs] Manual improvement suggestions Oct 19, 2023
@VaclavElias VaclavElias added the p2 High priority, or is required as a base for other things label Feb 18, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation enhancement New feature or request good first issue Good for newcomers help wanted Extra attention is needed p2 High priority, or is required as a base for other things
Projects
None yet
Development

No branches or pull requests

1 participant