[Docs] - Review - Content and Code Review

[VaclavElias]

We can start advertising some code only features and examples. Could you do an initial review on these pages?

• https://stride3d.github.io/stride-community-toolkit/manual/getting-started.html
  • I have tested it on clean Win 10 and Win 11 installs
• https://stride3d.github.io/stride-community-toolkit/manual/code-only/create-project.html
• https://stride3d.github.io/stride-community-toolkit/manual/code-only/examples/basic-examples.html
• https://stride3d.github.io/stride-community-toolkit/manual/code-only/examples/capsule-with-rigid-body.html
• https://stride3d.github.io/stride-community-toolkit/manual/code-only/examples/give-me-cube-body.html
• https://stride3d.github.io/stride-community-toolkit/manual/code-only/examples/stride-ui-capsule-with-rigid-body.html
• https://stride3d.github.io/stride-community-toolkit/manual/code-only/examples/advance-examples.html

There will be more examples and content of course! 😃

[JeromyWalsh]

On the first page, getting-started.html you have a section for adding the Nuget packages, but it's empty. I notice, however, that there's a section on the create-project.html which includes the instructions on getting the Nuget package. Maybe move that onto the getting-started page? Or at least copy/paste it.

create-project.html looks good.

basic-examples.html - I'd expect the The basic-examples.html page to be a link to the underlying example pages. Instead, there's no links from that page and is instead a screenshot of a console menu output. What value does this add? If we want to show off the console-based installer, it might be better to add that to the getting-started.html instead, so people are aware there is a console based menu system.

capsule-with-rigid-body.html - The top paragraph of this says: "This code example demonstrates how to initialize a game, set up a basic 3D scene, create a 3D capsule entity, set its position, and add it to the scene using the Stride Game Engine."

Beneath that, however, there is code that depends on the Stide.CommunityToolkit namespaces. I'd imagine that an example of how to initialize a game, etc. would be better suited for the Stride Manual, and I'm not sure why we need the Community Toolkit to do those things. If we feel the Community Toolkit provides an easier, more straightforward way of doing these things, we should consider making them part of the engine itself.

give-me-cube-body.html - This is literally the same as the previous page using a capsule. Seems redundant. This example may be better used inside of the Stride Manual under the "CreatePrimitive" documentation.

Finally - this image below shows a confusing navigation.

[VaclavElias]

Hi @JeromyWalsh,

Thank you for your feedback! 🙏 I've made the following updates:

1. getting-started.html - Added/updated the missing Adding the NuGet package section 📦
2. basic-examples.html - Improved wording and added an overview with links 📝. This section will receive further updates as more examples come in. Also explained the alternative console application approach 🖥️.
3. capsule-with-rigid-body.html - Corrected the wording and pointed to the toolkit 🛠️. For now, code-only game initialization is possible only through these extensions, which the toolkit wraps. If these extensions get integrated into the engine, the toolkit will be updated accordingly 🔄.
4. give-me-cube-body.html - This example also requires the toolkit 🧰. Examples will continue to be updated and improved to add extra value 🌟.
5. Fixed the confusing navigation 🗺️.

There is lots of work ahead and this was just an initial feedback I requested.