Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add documentation placeholders for other languages #2534

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 7 additions & 2 deletions docs/source-2.0/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -150,13 +150,18 @@ Read more
tutorials/index
Additional specs <additional-specs/index>
aws/index
ts-ssdk/index

.. toctree::
:caption: Languages
:maxdepth: 1

java/index
languages/java/index
languages/typescript/index
languages/rust/index
languages/python/index
languages/kotlin/index
languages/golang/index
languages/scala/index

.. toctree::
:caption: Project
Expand Down
13 changes: 13 additions & 0 deletions docs/source-2.0/languages/golang/index.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
======
GoLang
======

.. warning::

Smithy Go is currently in development and documentation is under construction

.. toctree::
:caption: References
:maxdepth: 1

Source code <https://github.com/aws/smithy-go>
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ and can be executed with `Gradle <https://gradle.org/>`_ (recommended) or the :r
:class: note

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

-----------------------------------
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ Java clients from a Smithy model of a service.

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

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

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

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ Users can use your SDK to list available coffees, order a coffee, and track the
:class: tip

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

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

------
Set Up
Expand Down
13 changes: 13 additions & 0 deletions docs/source-2.0/languages/kotlin/index.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
======
Kotlin
======

.. warning::

Smithy Kotlin is currently in development and documentation is under construction

.. toctree::
:caption: References
:maxdepth: 1

Source code <https://github.com/smithy-lang/smithy-kotlin>
13 changes: 13 additions & 0 deletions docs/source-2.0/languages/python/index.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
======
Python
======

.. warning::

Smithy Python is currently in development and documentation is under construction

.. toctree::
:caption: References
:maxdepth: 1

Source code <https://github.com/smithy-lang/smithy-python>
15 changes: 15 additions & 0 deletions docs/source-2.0/languages/rust/index.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
====
Rust
====

.. warning::

Smithy Rust is currently in development and documentation is under construction

.. toctree::
:caption: References
:maxdepth: 1

Design Documentation <https://smithy-lang.github.io/smithy-rs/design/>
Source code <https://github.com/smithy-lang/smithy-rs>

15 changes: 15 additions & 0 deletions docs/source-2.0/languages/scala/index.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
=====
Scala
=====

.. warning::

Smithy Scala support is community-provided and is not officially
supported by the Smithy team

.. toctree::
:caption: References
:maxdepth: 1

Documentation <https://disneystreaming.github.io/smithy4s/>
Source code <https://github.com/disneystreaming/smithy4s>
14 changes: 14 additions & 0 deletions docs/source-2.0/languages/typescript/index.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
==========
TypeScript
==========

.. toctree::
:maxdepth: 1

ts-ssdk/index

.. toctree::
:caption: References
:maxdepth: 1

Source code <https://github.com/smithy-lang/smithy-typescript>
1 change: 1 addition & 0 deletions docs/source-2.0/languages/typescript/ts-ssdk
1 change: 0 additions & 1 deletion docs/source-2.0/ts-ssdk

This file was deleted.

6 changes: 3 additions & 3 deletions docs/source-shared/ts-ssdk/index.rst
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
######################################
Smithy Server Generator for TypeScript
######################################
###############################
Server Generator for TypeScript
###############################

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

Expand Down
Loading