Adds new Docs Style Guide.#8500
Conversation
|
Looks good - comments inline. |
|
cool I do think this reads like the style guide is the most important thing in contributing to the docs - especially in light of this being the only document on http://docs.docker.com. Perhaps we need to mention more about examples, testing and exposition, and stress that we'd rather be given good information which can be cleaned up or re-written? can you add some declaration of war wrt double spaces after the end of a sentence (its come up a few times too) |
|
Okay, I think I've addressed all the comments and suggestions. Still can't squash commits due to rebase bug. I swear I'll work on fixing that today! Ping @jamtur01 @SvenDowideit @ostezer |
There was a problem hiding this comment.
Perhaps a link explaining what ESL stands for? 😄
There was a problem hiding this comment.
good point, i think this document asks for Three Letter Acrhonisms >sic< (TLAs) to be written out in full for their first use. he sits, petting his pet-ant
Adds a new style guide for docs. This is meant to be the definitive reference for all questions of how to write and style our docs. Includes changes to mkdocs yml and moves style info from docs README, adding a link instead. Made a couple edits to the README too, while I was in there.