Improve documentation#1515
Conversation
faheel
commented
Feb 2, 2018
faheel
commented
- Improve Markdown formatting
- Use lists and headings at appropriate places (eg. to list configuration options/properties)
- Increase heading levels that were too small
- Remove extra indentation at a few places
- Use consistent formatting rules for all Markdown files
- Files and folders are in bold
- Code and commands are in code spans/blocks and syntax highlighted
- Fix typos
- Fix broken links
bobbrow
left a comment
bobbrow
left a comment
There was a problem hiding this comment.
Thanks for the improvements to our documentation!
There was a problem hiding this comment.
I don't think that a question mark belongs here. No question is being asked.
There was a problem hiding this comment.
You're right. I'll fix it.
There was a problem hiding this comment.
any particular reason why the mailto: link is removed?
There was a problem hiding this comment.
The link seems to work without it? Maybe GitHub is smart about it and adds stuff.
There was a problem hiding this comment.
It was redundant. A mailto link is automatically generated for an email address.
* improve Markdown formatting * use consistent formatting rules for all Markdown files * fix typos * fix broken links
sean-mcmanus
left a comment
sean-mcmanus
left a comment
There was a problem hiding this comment.
Looks like a bunch of errors were fixed. And different tagging used. Seems good to me.
|
@bobbrow Were you okay with accepting this pull request? |
|
I'm confused. I didn't see any updates pushed to this PR and there is only one commit listed. When did it get updated? |
|
I squashed the changes suggested in the review into the original PR commit. |
3 participants
