dat-ecosystem-archive / docs

Documentation resources for dat and the surrounding ecosystem [ DEPRECATED - see https://github.com/hypercore-protocol/new-website/tree/master/guides for similar functionality. More info on active projects and modules at https://dat-ecosystem.org/ ]
https://dat-ecosystem-archive.github.io/docs/
530 stars 96 forks source link

One sentence per line to make diffs easier #168

Closed zootella closed 4 years ago

zootella commented 4 years ago

@RangerMauve @okdistribute let me know if you think this is a good idea! 'No thanks' is totally ok :)

This PR doesn't change any content or formatting of the rendered HTML.

Currently, there's no convention for how the prose of the documentation should be reflected in the text of the markdown. In many places, each paragraph is on a single line, Other places have one sentence per line, and still others put line breaks within sentences.

So, this PR would standardize on one sentence per line.

This makes diffs down the road a lot more readable. If you change wording within a sentence, or change the order of sentences in a paragraph, you end up with a diff that shows what happened.

okdistribute commented 4 years ago

Wow thanks zootella!