Skip to content

Add more documentation for Bots Configuration Options #184

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.

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

Open
wants to merge 8 commits into
base: main
Choose a base branch
from

Conversation

vanyabrucker
Copy link
Contributor

Adds detailed documentation with examples how to configure debug recording settings.

It might be good to add example requests for the other settings too. And we can remove and link "Configuration Options" from basics.md.

I am trying to add all the things I struggle to find to the documentation because I still have fresh blind eyes :D

Adds detailed documentation with examples how to configure debug recording settings.
@noah-duncan
Copy link
Collaborator

There is this weird thing at the top, currently. You'll see it when you do 'view' file in the github pr ui. Can you fix that?

image

@vanyabrucker
Copy link
Contributor Author

Sorry, don't know how that had happened. Fixed now!

@noah-duncan
Copy link
Collaborator

noah-duncan commented Apr 20, 2025

Hey sorry for not communicating this in my first comment. There is alot of overlap with the page you introduced and the configuration part of the 'basics' section here: https://github.com/noah-duncan/attendee/blob/c6237171c48dbcbfebd126e98759b09cced63f10/docs/basics.md#configuration-options. You should probably link from the basics section to this new page.

@noah-duncan
Copy link
Collaborator

Also, in order for your docs to show up in https://docs.attendee.dev you need to add them to this file https://github.com/noah-duncan/attendee/blob/main/scalar.config.json

We're using this service for the docs https://scalar.com/

@vanyabrucker
Copy link
Contributor Author

OK, I made the link and added it to scalar. Thanks Noah!

I also added some improved docstrings and exception handling related to this issue. I wanted to make a new PR and didn't see this is still open. Sorry!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants