Skip to content

Small fix for folder structure in docs #18

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.

Sign up for GitHub

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

Merged
timkpaine merged 2 commits into from
Jul 8, 2025
Merged

Small fix for folder structure in docs #18

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
832a5ed
Small fix for folder structure in docs
timkpaine Jul 8, 2025
021ddb1
Merge branch 'main' into tkp/docsfix
timkpaine Jul 8, 2025
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
4 changes: 2 additions & 2 deletions docs/wiki/Configuration.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ In the context of `csp-bot`, this means that we can control commands, backends,

Here is an example of a yaml-based configuration for the standard Slack-based chatbot:

**example/slack.yaml**
**example/bot/slack.yaml**

```yaml
# @package _global_
Expand Down Expand Up @@ -63,7 +63,7 @@ hydra:
name: csp-bot-slack[${bot_name}]
```

The `???` show that these fields should be overridden in other configs, which is exactly what we do in our `example/slack.yaml`.
The `???` show that these fields should be overridden in other configs, which is exactly what we do in our `example/bot/slack.yaml`.
We also see that the bot instance is configured with a `SlackConfig`.

For each backend supported, this is just a wrapper around the backend adapter's configuration:
Expand Down
2 changes: 1 addition & 1 deletion docs/wiki/Overview.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -98,7 +98,7 @@ class HelloCommandModel(BaseCommandModel):
To select commands, including custom commands, follow the documentation in [Configuration](Configuration).
For example, with a Slack bot and the above command in `hello.py`:

**my_bot_config/slack_with_hello.yaml**
**my_bot_config/bot/slack_with_hello.yaml**

```yaml
# @package _global_
Expand Down