Skip to content

Commit c18b835

Browse files
authored
Add documentation placeholders for supported languages (#2534)
1 parent 2f5e97d commit c18b835

File tree

19 files changed

+98
-10
lines changed

19 files changed

+98
-10
lines changed

docs/source-2.0/index.rst

Lines changed: 7 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -150,13 +150,18 @@ Read more
150150
tutorials/index
151151
Additional specs <additional-specs/index>
152152
aws/index
153-
ts-ssdk/index
154153

155154
.. toctree::
156155
:caption: Languages
157156
:maxdepth: 1
158157

159-
java/index
158+
languages/java/index
159+
languages/typescript/index
160+
languages/rust/index
161+
languages/python/index
162+
languages/kotlin/index
163+
languages/golang/index
164+
languages/scala/index
160165

161166
.. toctree::
162167
:caption: Project
Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
======
2+
GoLang
3+
======
4+
5+
.. warning::
6+
7+
Smithy Go is currently in development and documentation is under construction
8+
9+
.. toctree::
10+
:caption: References
11+
:maxdepth: 1
12+
13+
Source code <https://github.com/aws/smithy-go>

docs/source-2.0/java/client/generating-clients.rst renamed to docs/source-2.0/languages/java/client/generating-clients.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ and can be executed with `Gradle <https://gradle.org/>`_ (recommended) or the :r
99
:class: note
1010

1111
The Smithy CLI is a prerequisite for this guide.
12-
See the :doc:`Smithy CLI installation guide <../../guides/smithy-cli/cli_installation>`
12+
See the :doc:`Smithy CLI installation guide </guides/smithy-cli/cli_installation>`
1313
if you do not already have the CLI installed.
1414

1515
-----------------------------------

docs/source-2.0/java/client/index.rst renamed to docs/source-2.0/languages/java/client/index.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ Java clients from a Smithy model of a service.
99

1010
Smithy Java is currently in Developer Preview. All interfaces are subject to change.
1111

12-
For a general overview of the Smithy IDL, see the Smithy :doc:`../../quickstart` Guide
12+
For a general overview of the Smithy IDL, see the Smithy :doc:`/quickstart` Guide
1313

1414
For a general introduction the the Smithy Java framework, see the Smithy :doc:`../quickstart` Guide.
1515

docs/source-2.0/java/quickstart.rst renamed to docs/source-2.0/languages/java/quickstart.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ Users can use your SDK to list available coffees, order a coffee, and track the
1313
:class: tip
1414

1515
If you are new to Smithy or just need a refresher on the basics, you may find it helpful to work through the
16-
Smithy :doc:`../quickstart`.
16+
Smithy :doc:`/quickstart`.
1717

1818
-------------
1919
Prerequisites
@@ -22,7 +22,7 @@ Prerequisites
2222
* Ensure you have `JDK 17 <https://www.oracle.com/java/technologies/javase/jdk17-archive-downloads.html>`_ or higher
2323
installed. Older Java versions are not supported by Smithy Java.
2424
* Ensure you have the the Smithy CLI installed. Run ``smithy --version`` to confirm the CLI is correctly installed.
25-
If you need to install the CLI, see :doc:`Smithy CLI Installation <../guides/smithy-cli/cli_installation>`.
25+
If you need to install the CLI, see :doc:`Smithy CLI Installation </guides/smithy-cli/cli_installation>`.
2626

2727
------
2828
Set Up
Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
======
2+
Kotlin
3+
======
4+
5+
.. warning::
6+
7+
Smithy Kotlin is currently in development and documentation is under construction
8+
9+
.. toctree::
10+
:caption: References
11+
:maxdepth: 1
12+
13+
Source code <https://github.com/smithy-lang/smithy-kotlin>
Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
======
2+
Python
3+
======
4+
5+
.. warning::
6+
7+
Smithy Python is currently in development and documentation is under construction
8+
9+
.. toctree::
10+
:caption: References
11+
:maxdepth: 1
12+
13+
Source code <https://github.com/smithy-lang/smithy-python>
Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
====
2+
Rust
3+
====
4+
5+
.. warning::
6+
7+
Smithy Rust is currently in development and documentation is under construction
8+
9+
.. toctree::
10+
:caption: References
11+
:maxdepth: 1
12+
13+
Design Documentation <https://smithy-lang.github.io/smithy-rs/design/>
14+
Source code <https://github.com/smithy-lang/smithy-rs>
15+
Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
=====
2+
Scala
3+
=====
4+
5+
.. warning::
6+
7+
Smithy Scala support is community-provided and is not officially
8+
supported by the Smithy team
9+
10+
.. toctree::
11+
:caption: References
12+
:maxdepth: 1
13+
14+
Documentation <https://disneystreaming.github.io/smithy4s/>
15+
Source code <https://github.com/disneystreaming/smithy4s>
Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
==========
2+
TypeScript
3+
==========
4+
5+
.. toctree::
6+
:maxdepth: 1
7+
8+
ts-ssdk/index
9+
10+
.. toctree::
11+
:caption: References
12+
:maxdepth: 1
13+
14+
Source code <https://github.com/smithy-lang/smithy-typescript>
Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
../../../source-shared/ts-ssdk/

docs/source-2.0/ts-ssdk

Lines changed: 0 additions & 1 deletion
This file was deleted.

docs/source-shared/ts-ssdk/index.rst

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
1-
######################################
2-
Smithy Server Generator for TypeScript
3-
######################################
1+
###############################
2+
Server Generator for TypeScript
3+
###############################
44

55
The Smithy Server Generator for TypeScript is Smithy's officially-supported way to write web services in TypeScript.
66

0 commit comments

Comments
 (0)