Merge branch 'main' into fix/profile-by-alias

ApeWorX · Oct 10, 2024 · f2f1ea9 · f2f1ea9
2 parents 652a49e + 8d89588
commit f2f1ea9
Show file tree

Hide file tree

Showing 6 changed files with 22 additions and 17 deletions.
diff --git a/docs/commands/cluster.rst b/docs/commands/cluster.rst
@@ -1,5 +1,5 @@
 Cloud Platform
-**************
+==============
 
 .. click:: silverback._cli:login
     :prog: silverback login
@@ -15,12 +15,17 @@ Cloud Platform
     :nested: full
     :commands: new, list, info, update, remove
 
-.. click:: silverback._cli:docker_auth
-    :prog: silverback cluster docker auth
+.. click:: silverback._cli:registry_auth
+    :prog: silverback cluster registry auth
     :nested: full
     :commands: new, list, info, update, remove
 
 .. click:: silverback._cli:bots
     :prog: silverback cluster bots
     :nested: full
     :commands: new, list, info, update, remove, health, start, stop, logs, errors
+
+.. click:: silverback._cli:pay
+    :prog: silverback cluster pay
+    :nested: full
+    :commands: create, add-time, cancel
diff --git a/docs/commands/run.rst b/docs/commands/run.rst
@@ -1,5 +1,5 @@
 Local Development
-*****************
+=================
 
 .. click:: silverback._cli:run
   :prog: silverback run

diff --git a/docs/methoddocs/application.md b/docs/methoddocs/application.md
diff --git a/docs/methoddocs/main.md b/docs/methoddocs/main.md
@@ -0,0 +1,10 @@
+# silverback.main
+
+The `silverback.main` module contains the high-level implementation of the the user's
+Silverback application, meant to be used to expose method handlers and other functionality.
+
+```{eval-rst}
+.. automodule:: silverback.main
+    :members:
+    :show-inheritance:
+```
diff --git a/docs/userguides/development.md b/docs/userguides/development.md
@@ -79,7 +79,7 @@ from silverback import SilverbackBot
 bot = SilverbackBot()
 ```
 
-The SilverbackBot class handles state and configuration.
+The `SilverbackBot` class handles state and configuration.
 Through this class, we can hook up event handlers to be executed each time we encounter a new block or each time a specific event is emitted.
 Initializing the bot creates a network connection using the Ape configuration of your local project, making it easy to add a Silverback bot to your project in order to perform automation of necessary on-chain interactions required.
 

diff --git a/docs/userguides/platform.md b/docs/userguides/platform.md
@@ -152,7 +152,7 @@ Then you can provide the name of these credentials when creating your bot with t
 You are finally ready to deploy your bot on the Cluster and get it running!
 
 To deploy your Bot, use the [`silverback cluster bots new`][silverback-cluster-bots-new] command and give your bot a name,
-container image, network to run on, an account alias (if you want to sign transactions w/ `app.signer`),
+container image, network to run on, an account alias (if you want to sign transactions w/ `bot.signer`),
 and any environment Variable Group(s) the bot needs.
 If everything validates successfully, the Cluster will begin orchestrating your deployment for you.
 
@@ -197,7 +197,7 @@ Once in the RUNNING state, your Bot will not stop running unless it experiences
 Any task execution that experiences an error will abort execution (and therefore not produce any metrics) but the Bot **will not** shutdown.
 
 All errors encountered during task exeuction are reported to the Cluster for later review by any users with appriopiate access.
-Tasks do not retry (by default), but updates to `app.state` are maintained up until the point an error occurs.
+Tasks do not retry (by default), but updates to `bot.state` are maintained up until the point an error occurs.
 
 It is important to keep track of these errors and ensure that none of them are in fact critical to the operation of your Bot,
 and to take corrective or preventative action if it is determined that it should be treated as a more critical failure condition.