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

Update JetBrains Rider documentation #10025

Conversation

khalidabuhakmeh
Copy link
Contributor

Revised JetBrains Rider setup steps and clarified debug configurations. Replaced outdated .webp images with new .png files for newer and clearer screenshots.

Revised JetBrains Rider setup steps and clarified debug configurations. Replaced outdated .webp images with new .png files for newer and clearer screenshots.
Copy link
Contributor

@skyace65 skyace65 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please convert the pngs you created to webp. It's the standard format we're using with the docs going forward. The original images were definitely overcompressed but that's not an inherit flaw with webp, whoever made those just did that, you can make webps with lossless compression which is what we recommend. I would recommend using squoosh to convert those images and just use the maximum lossless compression.

@skyace65 skyace65 added enhancement area:contributing Issues and PRs related to the Contributing/Development section of the documentation labels Oct 2, 2024
Revised JetBrains Rider setup steps and clarified debug configurations. Replaced images with newer and clearer screenshots.
@khalidabuhakmeh
Copy link
Contributor Author

I've converted the images to webp as specified. Apologies. I saw some other png files in the directory and thought they were either.

mhilbrunner and others added 3 commits October 5, 2024 13:57
Add a note clarifying that this documentation is intended for contributing to the game engine, not for using JetBrains Rider as a C# or GDScript editor. Include reference to the C# guide for configuring an external editor.
@khalidabuhakmeh
Copy link
Contributor Author

👋 Hi folks, I'm not sure what the error message means here, as I'm unfamiliar with sphinx. I could change the title of the page to "Rider" but that's technically not the name of the product.

Fixed duplicate link based on the Sphinx format. This should fix the warning/error on the page.
@mhilbrunner mhilbrunner merged commit 464e320 into godotengine:master Oct 7, 2024
1 check passed
@mhilbrunner
Copy link
Member

Whew, that was a bit tricky. Merged. Thanks and congrats on your first merged contribution!

@khalidabuhakmeh
Copy link
Contributor Author

Thank you everyone for your help—cheers and happy to contribute.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area:contributing Issues and PRs related to the Contributing/Development section of the documentation enhancement
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants