General troubleshooting tips: updating user guide page to adhere to style guide
hannah-tillman opened this issue · comments
General:
Follow Google style guide for writing conventions
Break up bulky paragraphs when possible into smaller sections
Switch R and Python examples to lead with the Python example
Turn **Note:** into .. note::
Test links
Headers:
Switch to sentence case
==== > —— > ~~~~ > ‘’’’ > ^^^^ > **<>** > *<>* on every page
No verb ending in “ing” at the start
Accessibility:
Strong, concise alt text
Descriptive link text
Introduce tables/graphs/images