Writing Style
Avoid Long Paragraphs
Avoid really long paragraphs at all costs.
They are extremely hard to follow, specially when they are giving multiple distinct and separate instructions that could be broken down into more readable paragraphs instead.
Long paragraphs should be used with intention, and not out of "simplicity" or "low effort".
Use them only when they really do improve the quality of the learning process, and not just because the content accidentally grew into them.
Fix Grammatical Errors
Typos and grammatical errors should be fixed before requesting a review.
Please do a grammar correction pass before sending your PR. Specially if you are submitting a lot of text/content.
Ask for help if you still need help finding grammar and syntax errors after you do a first correction pass on your content.
Concise Titles
Avoid long and detailed titles as much as possible.
Use short and concise text that identifies the section and nothing more.
Accurate Titles
Titles will be the main reference used by the user for navigation with the Sidebar and Table of Contents.
As such, all pages are required to have good titles that accurately represent the contents of their respective section.
Titles are extremely crucial for SEO performance.
They will become part of the sitemap.xml file used by web crawlers to understand and navigate the website.
Please pay extra attention to their content.