Skip to content

Commit

Permalink
DOCSP-43493-docs-copilot
Browse files Browse the repository at this point in the history
  • Loading branch information
ltran-mdb2 committed Oct 1, 2024
1 parent 7c50b20 commit 2b2bf55
Show file tree
Hide file tree
Showing 2 changed files with 44 additions and 0 deletions.
40 changes: 40 additions & 0 deletions source/copilot-docs.txt
Original file line number Diff line number Diff line change
@@ -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



4 changes: 4 additions & 0 deletions source/copilot.txt
Original file line number Diff line number Diff line change
Expand Up @@ -32,10 +32,14 @@ Commands
The ``/query`` command assists in generating queries from a natural
language against a connected MongoDB cluster.

:ref:`/docs <vsce-copilot-docs>`
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

.. toctree::
:titlesonly:

/query </copilot-query>
/docs </copilot-docs>
AI & Data Usage </ai-data-usage>


0 comments on commit 2b2bf55

Please sign in to comment.