Skip to content

Commit 4498f2f

Browse files
dacharycdacharyc
committed
Scaffold ToC for consolidated SDK docs
1 parent 143b724 commit 4498f2f

File tree

706 files changed

+1419
-11
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

706 files changed

+1419
-11
lines changed

‎source/frameworks.txt

Lines changed: 31 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,31 @@
1+
.. _sdks-build-with-frameworks:
2+
3+
=====================
4+
Build with Frameworks
5+
=====================
6+
7+
.. contents:: On this page
8+
:local:
9+
:backlinks: none
10+
:depth: 2
11+
:class: singlecol
12+
13+
.. toctree::
14+
:titlesonly:
15+
16+
Electron </frameworks/electron>
17+
Flutter </frameworks/flutter>
18+
Maui </frameworks/maui>
19+
.NET </frameworks/dotnet>
20+
React Native </frameworks/react-native>
21+
SwiftUI </frameworks/swiftui>
22+
23+
The following pages contain information about building with specific
24+
frameworks using Atlas Device SDK:
25+
26+
- :ref:`sdks-build-with-electron`
27+
- :ref:`sdks-build-with-flutter`
28+
- :ref:`sdks-build-with-maui`
29+
- :ref:`sdks-build-with-dotnet`
30+
- :ref:`sdks-build-with-react-native`
31+
- :ref:`sdks-build-with-swiftui`

‎source/frameworks/dotnet.txt

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
.. _sdks-build-with-dotnet:
2+
3+
===============
4+
Build with .NET
5+
===============
6+
7+
.. contents:: On this page
8+
:local:
9+
:backlinks: none
10+
:depth: 2
11+
:class: singlecol
12+
13+
Placeholder page for information about building with .NET. (This may
14+
be a directory depending on how much content we have/need.)

‎source/frameworks/electron.txt

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
.. _sdks-build-with-electron:
2+
3+
===================
4+
Build with Electron
5+
===================
6+
7+
.. contents:: On this page
8+
:local:
9+
:backlinks: none
10+
:depth: 2
11+
:class: singlecol
12+
13+
Placeholder page for information about building with Electron. (This may
14+
be a directory as we have two pages for this?)

‎source/frameworks/flutter.txt

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
.. _sdks-build-with-flutter:
2+
3+
==================
4+
Build with Flutter
5+
==================
6+
7+
.. contents:: On this page
8+
:local:
9+
:backlinks: none
10+
:depth: 2
11+
:class: singlecol
12+
13+
Placeholder page for information about building with Flutter. (This may
14+
be a directory depending on how much content we have/need.)

‎source/frameworks/maui.txt

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
.. _sdks-build-with-maui:
2+
3+
===============
4+
Build with Maui
5+
===============
6+
7+
.. contents:: On this page
8+
:local:
9+
:backlinks: none
10+
:depth: 2
11+
:class: singlecol
12+
13+
Placeholder page for information about building with Maui. (This may
14+
be a directory depending on how much content we have/need.)

‎source/frameworks/react-native.txt

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
.. _sdks-build-with-react-native:
2+
3+
=======================
4+
Build with React Native
5+
=======================
6+
7+
.. contents:: On this page
8+
:local:
9+
:backlinks: none
10+
:depth: 2
11+
:class: singlecol
12+
13+
Placeholder page for information about building with React Native
14+
and ``@realm/react``.
15+
16+
This will be a directory with content.

‎source/frameworks/swiftui.txt

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
.. _sdks-build-with-swiftui:
2+
3+
==================
4+
Build with SwiftUI
5+
==================
6+
7+
.. contents:: On this page
8+
:local:
9+
:backlinks: none
10+
:depth: 2
11+
:class: singlecol
12+
13+
Placeholder page for information about building with SwiftUI.
14+
15+
This will be a directory with SwiftUI content.

‎source/index.txt

Lines changed: 15 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -14,20 +14,24 @@ Welcome to the Atlas Device SDK Docs
1414
:hidden:
1515

1616
Introduction </introduction>
17-
C++ SDK </sdk/cpp>
18-
Flutter SDK </sdk/flutter>
19-
Java SDK </sdk/java>
20-
Kotlin SDK </sdk/kotlin>
21-
.NET SDK </sdk/dotnet>
22-
Node.js SDK </sdk/node>
23-
React Native SDK </sdk/react-native>
24-
Swift SDK </sdk/swift>
25-
Web SDK </web>
26-
Atlas App Services <https://mongodb.com/docs/atlas/app-services>
17+
Install </sdk/install>
18+
Quick Start </sdk/quick-start>
19+
Model Data </sdk/model-data>
20+
Open & Manage Database Files </sdk/files>
21+
Read & Write Data </sdk/crud>
22+
React to Changes </sdk/react-to-changes>
23+
Access Atlas </sdk/atlas>
24+
Manage Users </sdk/users>
25+
Sync Data </sdk/sync>
26+
Logging </sdk/logging>
27+
SDK Telemetry </sdk/telemetry>
28+
API Reference </sdk/api-reference>
29+
Build with Frameworks </frameworks>
30+
Build for Platforms </platforms>
2731
Realm Studio </studio>
28-
Realm Query Language </realm-query-language>
2932
Example Projects </example-projects>
3033
Get Help </help>
34+
Atlas App Services <https://mongodb.com/docs/atlas/app-services>
3135

3236
.. introduction::
3337

‎source/platforms.txt

Lines changed: 29 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,29 @@
1+
.. _sdks-build-for-platforms:
2+
3+
===================
4+
Build for Platforms
5+
===================
6+
7+
.. contents:: On this page
8+
:local:
9+
:backlinks: none
10+
:depth: 2
11+
:class: singlecol
12+
13+
.. toctree::
14+
:titlesonly:
15+
16+
Android </platforms/android>
17+
Apple </platforms/apple>
18+
Linux </platforms/linux>
19+
Web </platforms/web>
20+
Windows </platforms/windows>
21+
22+
The following pages contain information about building for specific platforms
23+
with Atlas Device SDK:
24+
25+
- :ref:`sdks-build-for-android`
26+
- :ref:`sdks-build-for-apple`
27+
- :ref:`sdks-build-for-linux`
28+
- :ref:`sdks-build-for-web`
29+
- :ref:`sdks-build-for-windows`

‎source/platforms/android.txt

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
.. _sdks-build-for-android:
2+
3+
=================
4+
Build for Android
5+
=================
6+
7+
.. contents:: On this page
8+
:local:
9+
:backlinks: none
10+
:depth: 2
11+
:class: singlecol
12+
13+
Placeholder page for information about building for Android.
14+
15+
Include info about which frameworks we support building for Android, plus
16+
any specific version or compatibility info worth calling out?

0 commit comments

Comments
 (0)