Skip to content

Commit

Permalink
Address comments on content, move typescript pages to languages/types…
Browse files Browse the repository at this point in the history
…cript, fix build error
  • Loading branch information
joewyz committed Feb 26, 2025
1 parent d610c64 commit 539ca63
Show file tree
Hide file tree
Showing 3 changed files with 9 additions and 22 deletions.
2 changes: 2 additions & 0 deletions docs/source-2.0/languages/typescript/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -5,10 +5,12 @@ TypeScript
.. toctree::
:maxdepth: 1

quickstart
ts-ssdk/index

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

Source code <https://github.com/smithy-lang/smithy-typescript>
Smithy Full Stack Application </tutorials/full-stack-tutorial>
Original file line number Diff line number Diff line change
Expand Up @@ -6,23 +6,23 @@ This guide introduces `Smithy TypeScript <https://github.com/smithy-lang/smithy-
generated server and client.

For this example, imagine that you are the proud owner of a coffee shop.
Your API allows your customers to order some *typescript* from their TypeScript applications.
Your API allows your customers to order some *java* from their TypeScript applications.
Users can use your SDK to list available coffees, order a coffee, and track the status of their order.

.. admonition:: Review
: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
-------------

* :doc:`Smithy CLI <../guides/smithy-cli/cli_installation>`
* :doc:`Smithy CLI </guides/smithy-cli/cli_installation>`
* `Node.js (>= 16) <https://nodejs.org/en/download>`_ and `yarn <https://yarnpkg.com/getting-started/install>`_
* Ensure you have 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>`.

.. warning:: This project was made for Mac/Linux, it may not build correctly on Windows.

Expand Down Expand Up @@ -87,8 +87,6 @@ The service has the ``@restJson1`` protocol trait applied indicating that the se
Protocols define the rules and conventions for serializing and de-serializing data when communicating between
client and server.

Services can support multiple protocols at once.

From the root of the example project, build the service model using Gradle:

.. code-block:: sh
Expand Down Expand Up @@ -272,7 +270,7 @@ Finally, we can test the new operation using curl:
Which will return the hours of our Cafe:

.. code-block:: java
.. code-block:: sh
:caption: ``curl`` output
{"opensAt":9,"closesAt":16}
Expand Down Expand Up @@ -312,5 +310,6 @@ A new log line will now appear, listing the cafe’s hours:
----------
Next steps
----------

* Explore other examples: :doc:`Smithy TypeScript Full Stack Application </tutorials/full-stack-tutorial>`
* Check out the SSDK: :doc:`TypeScript SSDK <ts-ssdk/index>`
* Discover the Smithy ecosystem: `Awesome-Smithy <https://github.com/smithy-lang/awesome-smithy>`_
14 changes: 0 additions & 14 deletions docs/source-2.0/typescript/index.rst

This file was deleted.

0 comments on commit 539ca63

Please sign in to comment.