Skip to content

Commit df71ae6

Browse files
fix: update docs/userguides/development.md
Co-authored-by: El De-dog-lo <3859395+fubuloubu@users.noreply.github.com>
1 parent 8c29cad commit df71ae6

File tree

1 file changed

+4
-1
lines changed

1 file changed

+4
-1
lines changed

docs/userguides/development.md

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,10 @@ You can install Silverback via `pip install silverback`
99

1010
## Project structure
1111

12-
The `silverback` cli automatically searches for python scripts in the `bots/` directory at the root of your project. It will also automatically search for a `bot.py` module in either the `bots/` directory or at the root directory of the project. It is also suggested that you instantiate your `SilverbackApp()` object by naming the variable `bot`, since `silverback` autodetects that variable name in your bot.
12+
The `silverback` cli automatically searches for python scripts to run as bots in specific locations relative to the root of your project.
13+
It if finds a module named `bot.py` either in the `bots/` directory or at the root directory of the project, then it will use that by default.
14+
It will also be able to detect the scripts inside your `bots/` directory and let you run those by name (in case you have multiple bots in your project).
15+
It is suggested that you create the instance of your `SilverbackApp()` object by naming the variable `bot`, since `silverback` will autodetect that variable name when loading your script file.
1316

1417
If you have a more complicated project that requires multiple bots, naming each bot their own individual name is okay to do. It is still suggested that you name the variable that instantiates the application (`SilverbackApp()`) `bot`. An example is shown in the next section of this page.
1518

0 commit comments

Comments
 (0)