umbraco / UmbracoDocs

The official Umbraco Documentation
https://docs.umbraco.com
MIT License
269 stars 782 forks source link

Improve readability of the docs #4416

Closed sofietoft closed 1 year ago

sofietoft commented 2 years ago

Hacktoberfest is upon us, and on the UmbracoDocs we have a very important task that we need your help with:

Improving readability!

Some time back, we implemented a style guide on the documentation - a series of "rules" to ensure consistency in the docs and articles that are easy to read.

The style guide is implemented using Vale, and every time a commit is made to the UmbracoDocs, it will be checked against all of our rules. The rules can be found right here on the repository, and they include rules that recommends against the use of certain words, a rule that ensures that acronyms are defined and rules that ensures consistent spelling of certain terms.

How do I help out?

In order to make the task a little more edible, we've divided the docs into some sections.

Write a comment to this Issue, telling us which section you'd like to check, and make sure to reference this issue when you make the PR. That way we can keep track of the progress, and other contributors will know which sections are already done or being worked on πŸ’ͺ

Fundamentals

Implementation

Extending

Reference

Umbraco Cloud

erikjanwestendorp commented 2 years ago

@sofietoft I would like to work on the Fundamentals part. πŸ˜„

sofietoft commented 1 year ago

Thanks for all your amazing work on making our docs more readable @erikjanwestendorp πŸ™Œ πŸŽ‰ #H5YR

I no longer have the full overview, but it sure looks like you've covered a lot! I'll close this issue for now, as we are way past Hacktoberfest by now πŸ˜„