game-ci / documentation

📚 Documentation for GameCI open source projects
https://game.ci
MIT License
185 stars 119 forks source link

Hacktoberfest: Make an improvement to the user experience of this documentation website. #30

Open webbertakken opened 4 years ago

webbertakken commented 4 years ago

Problem description In documentation websites, aspects like readability, correctness and findability of specific subjects; sometimes texts are hard to read, too verbose or too concise or even no longer up-to-date and documentation is only as useful as the amount of people it helps, so finding the correct information easily is important.

Suggested solution Any improvement that will make it easier to read (including a11y), understand, navigate, share or give feedback will be very valuable. Feel free to suggest features below and link them to your pull requests.

anshdhinhgra47 commented 4 years ago

Hi Webber! Are you looking to add documentation on the GitHub repositories?

webbertakken commented 4 years ago

Hi @anshdhinhgra47,

Could you be more specific? Generally the documentation in here, moved from these repositories. But we're always trying to make peoples experience as smooth as possible. And the documentation can always be improved.

anshdhinhgra47 commented 4 years ago

I meant did you want the documentation for a certain project, to be put up in the repositories like the installation options, latest releases etc.?

webbertakken commented 4 years ago

Ah yes, I just realised it's not very clearly described which projects are documented in here. So we'll need to make that a little bit clearer also.

Here's the list of repositories that belong to the Unity-CI group:

I'm not sure if that answered your question @anshdhinhgra47?

@frostebite should your actions be added here too? what do you think?

anshdhinhgra47 commented 4 years ago

Now that's way clearer!!