Skip to content

Commit ee92fa6

Browse files
(DOCSP-19703) Index Page (#2)
1 parent 51569de commit ee92fa6

File tree

8 files changed

+84
-5
lines changed

8 files changed

+84
-5
lines changed

snooty.toml

Lines changed: 8 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,11 @@ name = "visual-studio-extension"
22
title = "Visual Studio Extension"
33

44
[constants]
5-
version = 1.0
6-
full-version = "{+version+}.0"
7-
name = "MongoDB Visual Studio Extension"
8-
home-page = "https://github.com/BorisDog/mongo-csharp-analyzer"
5+
product = "MongoDB Analyzer"
6+
product-home-page = "https://github.com/mongodb/mongo-csharp-analyzer"
7+
query-api = "MongoDB Query API"
8+
9+
driver-long = "MongoDB .NET driver"
10+
driver-short = ".NET driver"
11+
driver-version = 2.14
12+
driver-docs = "https://mongodb.github.io/mongo-csharp-driver/{+driver-version+}/"

source/builders.txt

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
TODO: write

source/configuration.txt

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
TODO: write
2+
3+
TODO: Incorporate Telemetery Information
4+
5+
.. important:: Telemetry
6+
7+
When the {+product+} analyzes your source code, the extension
8+
sends the following information to MongoDB:
9+
10+
- Your .NET version installed in Visual Studio
11+
- Your operating system
12+
- TODO: Make sure this list is exhaustive
13+
14+
To disable this feature, TODO: Include how to disable.
15+
16+
PREVIOUS DRAFT OF TELEMETRY STATEMENT ^

source/faq.txt

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
TODO: write

source/index.txt

Lines changed: 55 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1,55 @@
1-
Test Build
1+
.. _visual-studio-extension:
2+
3+
.. _visual-studio-extension-landing:
4+
5+
===============================
6+
{+product+}
7+
===============================
8+
9+
.. default-domain:: mongodb
10+
11+
.. toctree::
12+
:titlesonly:
13+
:maxdepth: 1
14+
15+
Installation </install>
16+
Builders </builders>
17+
LINQ </linq>
18+
Configuration </configuration>
19+
FAQ </faq>
20+
What's New </whats-new>
21+
22+
Overview
23+
--------
24+
25+
The `{+product+} <{+product-home-page+}>`__ is a tool
26+
that helps you understand the following about your {+driver-long+}
27+
code:
28+
29+
- How your code translates into the {+query-api+}
30+
- If your code includes unsupported LINQ or builder expressions
31+
32+
The {+product+} can analyze the following groups of {+driver-short+} expressions:
33+
34+
- `Builders <{+driver-docs+}reference/driver/definitions/>`__
35+
- `LINQ <{+driver-docs+}reference/driver/crud/linq/>`__
36+
- `LINQ3 <{+driver-docs+}reference/driver/crud/linq3/>`__
37+
38+
Read the following sections of this guide to learn how to install the
39+
{+product+}, how to use its features, and how to configure it:
40+
41+
- :doc:`Install the extension </install>`
42+
- :doc:`Analyze your builder expressions </builders>`
43+
- :doc:`Analyze your LINQ expressions </linq>`
44+
- :doc:`Configure the extension </configuration>`
45+
46+
To view answers to frequently asked questions, see the :doc:`FAQ </faq>` page.
47+
48+
To view the differences between versions of the extension,
49+
see the :doc:`What's New <whats-new>` page.
50+
51+
.. note:: Roslyn Analyzer
52+
53+
The {+product+} is a Roslyn Analyzer. To learn more about Roslyn Analyzers, see
54+
`Overview of Source Code Analysis <https://docs.microsoft.com/en-us/visualstudio/code-quality/roslyn-analyzers-overview?view=vs-2022>`__
55+
from Microsoft.

source/install.txt

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
TODO: write

source/linq.txt

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
TODO: write

source/whats-new.txt

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
TODO: write

0 commit comments

Comments
 (0)