stride3d/stride-community-toolkit

[Docs] Manual improvement suggestions

Aberta

#56 aberto em 19 de out. de 2023

 (0 comentário) (1 reação) (0 responsável)C# (31 forks)auto 404
documentationenhancementgood first issuehelp wantedp2

Métricas do repositório

Stars
 (125 estrelas)
Métricas de merge de PR
 (Métricas PR pendentes)

Description

  • 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

Guia do colaborador