Skip to content
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

Merged
merged 5 commits into from
Oct 17, 2023

Conversation

Fydar
Copy link
Contributor

@Fydar Fydar commented Oct 17, 2023

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

stride-vs-unity-interface-comparison

After

stride-vs-unity-unitylayout

stride-vs-unity-stridelayout

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
@VaclavElias
Copy link
Contributor

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.

@VaclavElias VaclavElias added enhancement New feature or request p2 High priority, or is required as a base for other things markdown content Docs content labels Oct 17, 2023
Copy link
Contributor

@Eideren Eideren left a 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.

@Fydar
Copy link
Contributor Author

Fydar commented Oct 17, 2023

I made them in Microsoft PowerPoint, which I do have a commercial license for.

Also added a Godot one because I know we have a page for Godot developers under construction <3

image

@VaclavElias
Copy link
Contributor

VaclavElias commented Oct 17, 2023

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.

@VaclavElias
Copy link
Contributor

I am ok to merge this.

@VaclavElias VaclavElias merged commit d502b1f into stride3d:master Oct 17, 2023
1 check passed
@IXLLEGACYIXL
Copy link
Contributor

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 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.

im fine if someone else wants to make the godot to stride

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
content Docs content enhancement New feature or request markdown p2 High priority, or is required as a base for other things
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants