Conversation
|
Following on the discord conversation:
08/03/2026 Update by Vaclav: Added Moved, Deleted, New, No Change labels. |
|
I'm opening this PR, as except for the redirects, it's ready for review |
|
I am sorry for the delays, this is still on my radar. |
|
Thanks for the updates. I didn't even check if the latest PR caused any merge conflicts. Anyway, I will be reviewing/working on this over this weekend. |
|
I am adding some notes I need to discuss internally, please, don't make these updates yet: This is currently deployed here: https://www.vaclavelias.com/stride-docs/4.3/en/manual/install-and-update/index.html ToDo: Vaclav, test https://dotnet.github.io/docfx/docs/config.html#url-redirects
My suggestions:
|
|
I agree with the vast majority of those changes, thanks for the work ! Not entirely convinced with the changes related to the extension though; we still need a dedicated page to document it I feel given that it is not part of the gamestudio itself, and does require additional documentation (which doesn't exist yet, granted) around how one is supposed to use it, and existing alternatives like the VS code version being developed by Tebjan. |
Did you mean my suggestions or generally ferafiks updates? Regarding the extension, we could keep the wording as it is here: https://www.vaclavelias.com/stride-docs/4.3/en/manual/install-and-update/install-stride.html#visual-studio-integration and get the original extension page back as 4th item in the Install and Update, so it could get more attention/content in the future (eventually). |
|
@VaclavElias @Eideren I'd like this PR to contain everything that needs to be improved in the getting started section, so if the extension page is needed, I could write one |
|
@VaclavElias both, I like Ferafiks' changes and think your suggestions are sensible @ferafiks as you want as long as we still have a dedicated page for the extension somewhere in the manual |
|
I have re-added the visual studio extension page under a different display name, so one less page to redirect. @VaclavElias about your suggestions:
Aside from those, I agree with most of your suggestions. I can add those if there is no need to discuss them any further |
Let's wait for confirmation on these above 1-4 which might lead to some feedback also on other suggestions. |
|
Latest updates deployed here https://www.vaclavelias.com/stride-docs/4.3/en/manual/install-and-update/index.html |
|
We can merge the two pages, I think the UX around managing versions isn't perfect, so I would rather we keep at least one of them up |
|
@Eideren I think this could just be a separate "changing versions of stride" or "managing versions" page. It would make it easier to search. Additionally now I also think it would be a good idea to include some text in the updating stride page about how that looks like in the launcher |
|
Sounds good |
This is quite a large PR, so I'm going to go over everything one by one.
Why?
The get started section is probably one of the most messy sections in the documentation. There is a lot of redundancy, unnecessary detail, lack of important information and lack of structure. This PR fixes that.
Changes
There is quite a lot of them.
1. New section - Install and update
The reason why I wanted to split off the get-started into two sections, was mainly because of the update-stride page. I think, a guide on how to update the engine shouldn't be included in the section for instructing the basics. This page only becomes useful after someone has already started using Stride and by that point, they shouldn't need to consult the "get started" section.
In that regard, having a dedicated section for installing and updating makes more sense in my opinion. For reference, that's how Unity does it.
Why not remove the page?
I think that there shouldn't be a need for a page like that, but for now, Stride has it's quirks and having them documented somewhere is a good idea.
2. Moving the requirements page
I think there are too many things without a section sitting at the top of the sidebar. This section seemed like the best place for this page.
I also moved the page's location and updated it in the major release workflow page, but I can move it back if that causes any issues.
3. Trimming the installation page
The install-stride page was incredibly long and pretty much just boiled down to "press things on the screen until success". Other engines either don't have a page for that (Godot), or keep it very brief (Unity). Having such a detailed guide makes it harder to read through and harder to maintain in case the installation process changes in the future.
4. Removal of Stride Launcher page
The Stride Launcher is an incredibly straight-forward piece of software. The documentation either explained already easy to understand things or re-explained them in a worse way. The launcher is made to be intuitive to use, so I see no point in providing more information on it.
Also, it wasn't under any section for some reason which made it quite odd.
5. Removal of Visual Studio extension page
The page didn't contain much useful information. It made a lot more sense to include it in the
install stridepage as a section.6. Removal of Launch Stride page
This page was a rehash of previous pages and the "launch stride" part was located at the very bottom and said to press the giant red button "Start" to start the engine. I don't think having this page is that necessary.
7. Removal of Game Studio, Assets and Scenes
The main reason is that I wanted to write different, more concise versions of these pages/sections that focused more on getting people started, than going in-depth. Also, having multiple items on the sidebar linking to the same page made it a bit weird to navigate and easier to get lost in what section you are reading.
8. Removal of "Remove Borders" section from launch a game page
Why is that there?
I also created a PR that got merged, that included a dedicated page for these sort of things.
New things
Minor:
Before I start going through the major things, I want to explain what the point of the get started section is for me. Get started is supposed to be a basic guide on how to start working with the engine. It is not meant to explain everything the engine has to offer, but only what is needed. After the guide, the user is expected to either: try to create something by themselves in the engine and learn things as they go OR start reading other pages of the documentation.
In addition: I don't think the section is meant to teach a complete beginner that had no previous experience with game development on how to make games. I don't think any documentation is capable of that. It's more targeted at people who only had experience with basic frameworks, only did non-game coding or worked on games in a different engine that we don't have a dedicated guide for (which means everything except Unity).
1. Key Concepts
This page is meant to serve as a introduction to a few key terms and concepts used in Stride.
2. Game Studio
This page is meant to teach on how to use the Game Studio. It's a more shrunk down version of the game studio section, focused on explaining just the basics. This is why it skips over some of the panels.
3. Assets
This page is meant to teach about how to create assets and how they work. I skipped everything related to loading assets or using them in code, as when getting started, they will at most be used when editing a scene in Game Studio.
4. Next steps
This page is meant to direct a user to what they should do next after finishing the section.
TODO: