-
Notifications
You must be signed in to change notification settings - Fork 66
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
Updating Stride for Unity Developers documentation #176
Conversation
The screenshot of the Unity UI is a non-standard Unity UI and does not resemble the default Unity UI nor any UI that I have ever encountered in my professional career in Unity. Taking my own screenshot using Unity's Default layout, which is much more common. Updated the style of the screenshots to work better across both light and dark theme. Made the screenshots seperate images for a better user experience.
Use proper names for Unity windows. Made code snippets a consistent code style and attempted to introduce more partity between the Unity snippets and the Stride snippets. Fixed badly formatted Markdown
Your images look very good. What tool did you use. Would you be ok to change them to .webp, if it decreases the file size of the image and you are also ok with the image quality result? @Eideren, could you please review. I like the update very much, especially because of the styling and formatting improvements but I can't review the content. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Looks good, just one note:
AFAIK we're following standard .NET style for documentation. Yeah, the source doesn't match that style perfectly, it's too late to adopt it.
So best to remove explicit private access modifiers for functions if they do not matter for the given explanation.
If you would like, you can finish the Godot one. I believe @IXLLEGACYIXL will be ok with that. He prepared the content #128 and then I started adding it to the new page https://github.com/stride3d/stride-docs/blob/master/en/manual/stride-for-godot-developers/index.md as he is not familiar with markup and docs as I am. But I am not familiar with Godot and game dev generally 🤣🙈. And then Eideren made additional updates in the Stride for Unity Devs page and now also you. I would suggest just to copy this page (once merged) https://github.com/stride3d/stride-docs/blob/master/en/manual/stride-for-unity-developers/index.md and update accordingly based on the files above, including adding or removing the sections. |
I am ok to merge this. |
im fine if someone else wants to make the godot to stride |
I am personally one of those Unity developers that this documentation is for and when I saw the screenshots of the Unity Editor layout I laughed because it has been years since I saw a Unity Editor look like that.
So I started out by redoing the screenshots of both Stride and Unity and updated them so they looked better on dark theme.
Turns out, Stride looks a lot more like the default Unity Editor layout than the old screenshots would have betrayed.
Then I went on and updated some of the things I noticed where inaccurate in the markdown.
Before
After