Improve documentation #1515
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
|
|
||
| #### How fallback works and how to control the behavior | ||
| ### How fallback works and how to control the behavior? |
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.
Documentation/LanguageServer/FAQ.md
Outdated
| * [How do I get IntelliSense to work correctly?](#how-do-i-get-intellisense-to-work-correctly) | ||
| * [Why do I see red squiggles under Standard Library types?](#why-do-i-see-red-squiggles-under-standard-library-types) | ||
| * [How do I get the new IntelliSense to work with MinGW on Windows?](#how-do-i-get-the-new-intellisense-to-work-with-mingw-on-windows) | ||
| * [What is the difference between `"includePath"` and `"browse.path"` in **c_cpp_properties.json**?](#what-is-the-difference-between-includepath-and-browsepath-in-c-cpp-propertiesjson) |
There was a problem hiding this comment.
The link appears to be removed (link #4)
|
|
||
| ### Microsoft Open Source Code of Conduct | ||
| This project has adopted the [Microsoft Open Source Code of Conduct](https://opensource.microsoft.com/codeofconduct/). For more information see the [Code of Conduct FAQ](https://opensource.microsoft.com/codeofconduct/faq/) or contact [opencode@microsoft.com](mailto:opencode@microsoft.com) with any additional questions or comments. | ||
|
|
||
| This project has adopted the [Microsoft Open Source Code of Conduct](https://opensource.microsoft.com/codeofconduct/). For more information see the [Code of Conduct FAQ](https://opensource.microsoft.com/codeofconduct/faq/) or contact opencode@microsoft.com with any additional questions or comments. |
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
|
@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. |
