Skip to content
Merged
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
8 changes: 8 additions & 0 deletions docs/nextra/api/steamship.agents.mixins.transports.rst
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,14 @@ steamship.agents.mixins.transports package
Submodules
----------

steamship.agents.mixins.transports.slack module
-----------------------------------------------

.. automodule:: steamship.agents.mixins.transports.slack
:members:
:undoc-members:
:show-inheritance:

steamship.agents.mixins.transports.steamship\_widget module
-----------------------------------------------------------

Expand Down
59 changes: 10 additions & 49 deletions docs/nextra/index.rst
Original file line number Diff line number Diff line change
@@ -1,11 +1,9 @@
Steamship
=========

Steamship is the fastest way to add AI to your software.

Think of Steamship as both a package manager and package hosting for AI.
Each `Steamship package <https://www.steamship.com/packages>`_ runs in the cloud on a managed stack.
Steamship is an SDK and hosting platform for AI Agents and Tools.

**Follow our [Agent Guidebook](/agent-guidebook) for a complete tutorial.**

Steamship in 30 seconds
-----------------------
Expand All @@ -17,15 +15,13 @@ Steamship in 30 seconds

The best way to start is to make a simple package:

Start from a template
---------------------
## Start from our Multimodal Agent Template

Clone one of our starter packages (https://github.com/steamship-packages):
Clone our starter repository:

.. code-block:: bash

git clone https://github.com/steamship-packages/empty-package.git

git clone https://github.com/steamship-core/multimodal-agent-starter

Create a virtual environment and install dependencies:

Expand All @@ -37,55 +33,20 @@ Create a virtual environment and install dependencies:
pip install -r requirements.txt
pip install -r requirements.dev.txt

and start editing ``src/api.py``.

Start from scratch
------------------
First, install our SDK and CLI (ideally in a virtual environment):
Then run:

.. code-block:: bash

python3 -m venv venv
source venv/bin/activate

pip install steamship

Now copy this into ``api.py``:

.. code-block:: python

from steamship.invocable import post, PackageService

class MyPackage(PackageService):

@post("hello_world")
def hello_world(self, name: str = None) -> str:
return f"Hello, {name}"

Next Steps
==========

.. grid:: 1 1 2 3

.. grid-item-card:: **Using Packages**
:link: packages/using.html

Use full-stack language AI packages in your own code.

.. grid-item-card:: **Developing Packages**
:link: packages/developing/index.html

Build and deploy packages with our low-code framework.

.. grid-item-card:: **Package Cookbook**
:link: packages/cookbook/index.html
ship run local

Package examples for common scenarios.
Now that you've interacted with your new agent, you're ready to start modifying it in :code:`src/api.py`.

See the **[Agent Guidebook](/agent-guidebook)** for details.

Contents
========

* [Agent Guidebook](agent-guidebook)
.. toctree::
:maxdepth: 4

Expand Down
8 changes: 5 additions & 3 deletions docs/nextra/make_markdown.sh
Original file line number Diff line number Diff line change
Expand Up @@ -12,13 +12,15 @@ find "$DOCSDIR" -type f | while read -r file; do
# Get the file's directory
dir=$(dirname "$file")

# If the file is within a directory named 'api', skip it
if [[ $dir == *"/api"* ]]; then
# If the file is within a directory named 'api', or agent-guidebook skip it
if [[ $dir == *"/api"* ]] || [[ $dir == *"/agent-guidebook"* ]]; then
continue
fi



# If the file isn't '_meta.json' or '_app.mdx', delete it
if [[ "$(basename "$file")" != "_meta.json" ]] && [[ "$(basename "$file")" != "_app.mdx" ]] && [[ "$(basename "$file")" != "pages.md" ]]; then
if [[ "$(basename "$file")" != "_meta.json" ]] && [[ "$(basename "$file")" != "_app.mdx" ]] && [[ "$(basename "$file")" != "pages.md" ]] && [[ "$(basename "$file")" != "react.mdx" ]] && [[ "$(basename "$file")" != "agent-guidebook.md" ]]; then
rm "$file"
fi
done
Expand Down