search

MycroftAI / documentation

Mycroft.AI documentation for all public facing technical components.
https://mycroft.ai/documentation
Apache License 2.0
80 stars 90 forks source link

skills dev intro: improve formatting and readability #40

Closed zachwelch closed 6 years ago

zachwelch commented 6 years ago

This patch improves the readability of the "Introduction to Skill Development" document.

Mostly, it eliminates a lot of spurious vertical whitespace by using more inline markup. There are a few bonafide typo fixes, as well as a handful of minor rewrites for clarity.

Any lines that I touched also got wrapped to 72 character line wide. Shorter lines drastically improve the quality of patches against the tree. This change also accommodates developers that want to use an 80-character wide terminal. Due to the patch quality factor alone, I am curious why a hard line length is not already a standard in the documentation.

KathyReid commented 6 years ago

No response from submitter; closing