Add informations on editing the server config

diplomat-lsp-src/source/index.rst

@@ -11,6 +11,7 @@ Diplomat documentation
 
    introduction/intro
    introduction/setup
+   introduction/configuration
 
 
 

diplomat-lsp-src/source/introduction/configuration.rst

@@ -0,0 +1,56 @@
+Configuring Diplomat
+====================
+
+Setting up the source tree
+--------------------------
+
+When opening a folder for the first time, Diplomat will recursively scan the folder to detect 
+all source file and try to infer a source tree. 
+Without more configuration, you will have multiple top level files which is probably not what is wanted.
+
+This will probably lead to a lot of warnings and errors that may not be relevant.
+For a simple workspace, this very basic setup may be enough. 
+
+Selecting the top-level
+.......................
+
+The selection of the top-level file is made by a right click on the file in the filetree view of Visual Code.
+
+.. figure:: /img/select_top_level_dark.png
+    :figclass: only-dark
+    :align: center
+
+    Top level file selection
+
+.. figure:: /img/select_top_level_light.png
+    :figclass: only-light
+    :align: center
+
+    Top level file selection
+
+.. tip:: 
+    After changing the top-level file, it may be required to manually reindex the workspace.
+    To do so, use ``Diplomat: Reindex`` command from the command palette.
+
+Excluding files
+...............
+
+For several reason, it will be useful to remove files or even directory.
+This is done by right-clicking on the file or folder to exclude and select ``Ignore path for Diplomat LSP``.
+
+.. warning:: 
+    There is no visual feedback upon ignoring a file and there is a need to reindex (either by using the command or by saving a file).
+
+
+Saving and loading the configuration
+..................................... 
+
+Once you configured your workspace, you should save this configuration using the ``Diplomat: Save the workspace configuration from the server`` command.
+This will save all the workspace configuration into a json file in a location determined by VSCode.
+
+This configuration file should not have to be edited manually as it reflects the result of user commands.
+However, the command ``Diplomat: Open config file`` will open this file for edition in VSCode.
+
+Normally, the settings are loaded upon starting the language server.
+If the loading fails upon startup (which may happen) or if the file has been manually updated, the settings may be reloaded from the file with the command
+``Diplomat: Load the workspace configuration to the server``