Documentation review

[acastrodev]

File	Wording	Issue/Suggestion
Several documents	[!Note] vs [!NOTE]	It is a minor thing. There is a predominance of the term [!Note] over the term [!NOTE]. As a suggestion, we can normalize it to [!Note]. Same for other tags.
examples/Stride.Utilities-remarks.md	important in a Windows 8.x Store app	Possible outdated information.
manual/animation/additive-animation.md	"In the scene view, select the entity you want to animate."	Possible typo, should it be: "In the Scene Editor, select the entity you want to animate."?
manual/animation/animation-properties.md	If you have custom attribute in the animation file...	Possible missing content for "Import custom attributes."
manual/animation/custom-blend-trees.md	"you can create a script which inherits from IBlendTreeBuilder"	Suggestion: "you can create a script which implements from IBlendTreeBuilder"
manual/animation/import-animations.md	"Stride supports the following model file types: .3ds, .blend, .dae, .dxf, .fbx, .md2, .md3, .obj, .x"	Added a comment in this issue with the current supported animation files. New wording suggestion: "Stride supports the following model file types: .3ds, .blend, .dae, .dxf, .fbx, .glb, .gltf, .md2, .md3, .obj, .ply, .stl, .stp, .x"
manual/audio/audio-listeners.md	"Add Component"	Minor change for consistency: "Add component"
manual/audio/custom-audio-data.md	"For an example of how to implement this, see the CompressedSoundSource` source code."	Link is not working. Also, as suggestion, it could be: "For an example of how to implement this, see the CompressedSoundSource source code."
manual/audio/hrtf.md	"Solution Explorer"	Minor change for consistency: "Solution explorer"
manual/audio/hrtf.md	"For now, you can only use HRTF on Windows 10."	Possible outdated information.
manual/audio/import-audio.md	"click Add assett and select Media > Video."	Minor change. Typo in asset: "click Add assett and select Media > Video."
manual/audio/import-audio.md	"Spatialized sound"	Minor change for consistency: "Spatialized audio"
manual/audio/non-spatialized-audio.md	"By default, each speaker a value of 0.5."	Suggestion: "By default, each speaker has a value of 0.5."
manual/audio/play-a-range-within-an-audio-file.md	"//Assume sample length is 5 seconds."	Consistency, missing space: "// Assume sample length is 5 seconds."
manual/audio/spatialized-audio.md	"For example, the frequency (pitch) of the sound"	Consistency, other cases refers to pitch (frequency): "For example, the pitch (frequency) of the sound"
manual/diagnostics/STRDIAG002.md	"Immutable types in this context are none reference types and string"	Possible typo in: "none reference"
manual/diagnostics/STRDIAG004.md	"remove the @Stride.Core.DataMemberAttribute ."	Extra space before period.
manual/diagnostics/STRDIAG004.md	"// STRDIAG000.cs"	Probably the comment can be removed.
manual/engine/assets/index.md	This section is out of date. For now, you should only use it for reference.	Same as the item above.
manual/engine/entity-component-model/index.md	"Dog is a subclasses of Animal."	Suggestion: "Dog is a subclass of Animal."
manual/engine/index.md	This section is out of date. For now, you should only use it for reference.	You must probably are aware already of that. :)
manual/engine/resources.md	"Resources are images, texture (.dds files"	Missing ): "Resources are images, texture (.dds files)" as alternative we could just remove the parenthesis
manual/files-and-folders/cached-files.md	"To do this, under Stride, select Clean intermediate assets for Solution."	Using VS 2022: " To do this, under Extensions > Stride, select Clean intermediate assets for Solution."
manual/files-and-folders/distribute-a-game.md	"For instructions about how to install Xamarin with Visual Studio 2017, see this MSDN page."	Possible outdated information (VS 2017)
manual/files-and-folders/distribute-a-game.md	"files that contain vshost in their filenames (eg MyGame.vshost.exe and MyGame5.vshost.exe.manifest)"	Possible typo in "MyGame5"
manual/files-and-folders/distribute-a-game.md	"To run games made with Stride on Windows, users need: .NET 4.6.1"	Possible incorrect .NET framework version
manual/index.md	"Follow Stride on Twitter"	"Follow Stride on X"
manual/toc.md	"Entity component model"	Title of this page was recently updated. Suggestion: Update TOC as well "ECS (Entity Component System)"

[VaclavElias]

Thank you, this is going to be very helpful!

[acastrodev]

Related with:

File	Wording	Issue/Suggestion
import-animations.md	"Stride supports the following model file types: .3ds, .blend, .dae, .dxf, .fbx, .md2, .md3, .obj, .x"	New wording suggestion: "Stride supports the following model file types: .3ds, .blend, .dae, .fbx, .glb, .gltf, .md2, .md3, .x"

Not sure all extensions listed here support animation:

[IXLLEGACYIXL]

#165 affects the strdiag diagnostics and are currently worked on. should be ready for release soon :D

[acastrodev]

Is the attribute DataMember(DataMemberMode.Assign) intentionally duplicated?
https://github.com/stride3d/stride-docs/blob/master/en/diagnostics/STRDIAG006.md

[VaclavElias]

Nope! It seems that I did that by accident, hmm, weird.

[VaclavElias]

Just adding a note for later. Manual should have a section, where some basic terms are explained and linked accordinglly with the rest of docs. For example what is actually Entity.

• Unity examples https://docs.unity3d.com/Manual/class-GameObject.html
  • This should be also in Stride under Scripting - Important Classes
• Unity examples https://docs.unity3d.com/Manual/Unity2D.html
  • We should also have this section