Documentation for Godot | PanoramaSky and ProceduralSky

in #utopian-io4 years ago

Repository

https://github.com/godotengine/godot

Details

Godot recently celebrated their 3.0 release. With so many features the documentation has fallen far behind the state of the engine. This work represents an attempt to begin completing many classes that have fallen between the cracks.

Components

There are two classes documented in these PRs. They both inheret from the base class Sky.

Panorama Sky

The PanoramaSky is the best way to display a background. It replaces the traditional sky boxes found in most game engines. Godot uses a single equirectangular texture instead of a six sided box.

Procedural Sky

The ProceduralSky is a great way to get a quick sky up and running. Users coming from Unity3D will be familiar with it. It allows the user to quickly define a sky by creating a couple gradients and defining a sun position. The result is baked into a texture and displayed as a background similar to

Links

At the time of this posting the doc pages are empty, if you want to view the changes check out the github PRs at the bottom of this post. Soon the changes to the github will be reflected on the state of the website.

GitHub Proof of Authorship

Sort:  

This contribution is not upto the mark to be called a documentation contribution.

I would like you to work more on the documentation part to submit a documentation contribution.

I will link you to example of a good documentation contribution.

Link

Thank you


Need help? Write a ticket on https://support.utopian.io/.
Chat with us on Discord.
[utopian-moderator]

That was a very rude way to say that my contribution was too short to be considered by Utopian.

You have to understand that writing documentation for a large open source project is not the same as documenting functions in your own github repo. For a large project you have to learn the code base, coordinate with others and write high quality documentation. Whereas for your own code base you can churn out the entire documentation in a short time because you have intimate knowledge of the code. However, a smaller contribution to a large project adds more value to the community especially for new users who can't learn from the source code.

I would appreciate your feedback.

Sorry if I sounded rude @clayjohn.

I wanted to highlight that the commit you have submitted as the contribution was too short in comparison to other contributions.

I would like to be honest but I am not advising you to contribute to other large project but I wanted to encourage you to work more on the documentation part.

Loooking more into this I found the repository where this whole project is documented - https://github.com/godotengine/godot-docs

And the official documentation can be found here - http://docs.godotengine.org/en/3.0/

I am encouraging you to do more work in the contribution.

In Utopian we appreciate most the quality of work provided indeed.

Thanks,

Hope you understand my message to you

Congratulations @clayjohn! You have completed some achievement on Steemit and have been rewarded with new badge(s) :

Award for the number of comments
Award for the number of upvotes

Click on any badge to view your own Board of Honor on SteemitBoard.
For more information about SteemitBoard, click here

If you no longer want to receive notifications, reply to this comment with the word STOP

Upvote this notification to help all Steemit users. Learn why here!

Congratulations @clayjohn! You have completed some achievement on Steemit and have been rewarded with new badge(s) :

Award for the number of upvotes

Click on any badge to view your Board of Honor.
For more information about SteemitBoard, click here

If you no longer want to receive notifications, reply to this comment with the word STOP

Do not miss the last announcement from @steemitboard!

Do you like SteemitBoard's project? Vote for its witness and get one more award!

Coin Marketplace

STEEM 0.35
TRX 0.06
JST 0.046
BTC 38651.65
ETH 2806.95
USDT 1.00
SBD 4.35