[PATCH] D31887: [clangd] Add documentation page

[Jonas Devlieghere via Phabricator via cfe-commits]

JDevlieghere added a comment.

Great to see this coming along!



================
Comment at: docs/clangd.rst:10
+
+:program:`clangd` is an implementation of the `Language Server Protocol <https://github.com/Microsoft/language-server-protocol>`_ leveraging Clang.
+Clangd's goal is to provide language "smartness" features like code completion, find references, etc. for clients such as C/C++ Editors.
----------------
s/clangd/Clangd


================
Comment at: docs/clangd.rst:10
+
+:program:`clangd` is an implementation of the `Language Server Protocol <https://github.com/Microsoft/language-server-protocol>`_ leveraging Clang.
+Clangd's goal is to provide language "smartness" features like code completion, find references, etc. for clients such as C/C++ Editors.
----------------
JDevlieghere wrote:
> s/clangd/Clangd
Reflow text to 80 columns


================
Comment at: docs/clangd.rst:20
+At the moment, `Visual Studio Code <https://code.visualstudio.com/>`_ is mainly used
+in order to test :program:`Clangd`` but more clients are likely to make use of :program:`Clangd`` in the
+future as it matures and becomes a production quality tool. If you are interested
----------------
Spurious backticks


================
Comment at: docs/clangd.rst:22
+future as it matures and becomes a production quality tool. If you are interested
+in trying :program:`Clangd`` in combination with Visual Studio Code, you can start by `building Clangd`_,
+then open Visual Studio Code in the clangd-vscode folder and launch the extension.
----------------
Spurious backtick


================
Comment at: docs/clangd.rst:33
+
+Many features could be implemented in :program:`Clangd``.
+Here is a list of features that could be useful with the status of whether or
----------------
Spurious backtick


================
Comment at: docs/clangd.rst:35
+Here is a list of features that could be useful with the status of whether or
+not they are already implemented in :program:`Clangd`` and specified in the Language Server Protocol.
+Note that for some of the features, it is not clear whether or not they should be part of the
----------------
Spurious backtick


================
Comment at: docs/clangd.rst:37
+Note that for some of the features, it is not clear whether or not they should be part of the
+Language Server Protocol, so those features might be eventually developed outside :program:`Clangd``.
+
----------------
Spurious backtick


================
Comment at: docs/clangd.rst:91
+A good place for interested contributors is the `Clang developer mailing list <http://lists.llvm.org/mailman/listinfo/cfe-dev>`_.
+If you're also interested in contributing patches to Clangd, take a look at the
+`LLVM Developer Policy <http://llvm.org/docs/DeveloperPolicy.html>`_ and `Code Reviews <http://llvm.org/docs/Phabricator.html>`_ page.
----------------
:program:`Clangd` 


================
Comment at: docs/clangd.rst:94
+Contributions of new features to the `Language Server Protocol <https://github.com/Microsoft/language-server-protocol>`_ itself would also be very useful,
+so that Clangd can eventually implement them in a conforming way.
----------------
:program:`Clangd` 


https://reviews.llvm.org/D31887