diff --git a/source/copilot-docs.txt b/source/copilot-docs.txt new file mode 100644 index 0000000..052038f --- /dev/null +++ b/source/copilot-docs.txt @@ -0,0 +1,40 @@ +.. _vsce-copilot-docs: + +============== +/docs Command +============== + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +The ``/docs`` command provides MongoDB specific information to users, +supplemented by links to MongoDB Documentation. The |copilot| is +knowledgeable of the latest MongoDB Documentation and uses the +MongoDB Docs Chatbot API to link users to information in addition to +the textual response. + +Examples +~~~~~~~~ + +Create an Index +~~~~~~~~~~~~~~~ + +You can ask the |copilot| to link you to relevant MongoDB Documentation. +For example, consider the following prompt in the GitHub Copilot chat : + +.. code-block:: javascript + :copyable: false + + @MongoDB /docs can you link me to documentation on creating an index? + +The chat responds with the following pages: + +- G + + + \ No newline at end of file diff --git a/source/copilot.txt b/source/copilot.txt index 4e1e9d2..9ef72b8 100644 --- a/source/copilot.txt +++ b/source/copilot.txt @@ -32,10 +32,14 @@ Commands The ``/query`` command assists in generating queries from a natural language against a connected MongoDB cluster. +:ref:`/docs ` +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + .. toctree:: :titlesonly: /query + /docs AI & Data Usage