mkdc/BotYam
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

ReadTheDocs compatibility

Browse source
This commit is contained in:
Lucy Joshua 2023-02-06 21:46:41 +02:00
parent 20064748b1
commit 96e5c3afe6
3 changed files with 10 additions and 5 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

6
docs/files/data.md
View file

@ -1,6 +1,7 @@
# Data for nerds # Data for nerds
WARNING: Before contributing, read the [license](license.md). !!! warning
Before contributing, read the [license](license.md).
Here you have something to get, if you want to participate in the coding and somehow you got included - congrats! You are in. Here you have something to get, if you want to participate in the coding and somehow you got included - congrats! You are in.
Here are the basic knowledge stuff. Here are the basic knowledge stuff.
@ -14,7 +15,8 @@ The DB is used for storing everything in stores, as its credentials are currentl
## API Tokens ## API Tokens
The API tokens are stored in the API hash, used to communicate with Twitter API. The API tokens are stored in the API hash, used to communicate with Twitter API.
WARNING: As stated before, the API will have a massive update in February 9th. !!! warning
As stated before, the API will have a massive update in February 9th.
## The Data Structure ## The Data Structure

3
docs/files/index.md
View file

@ -2,6 +2,7 @@
Welcome to the Bot Yam documentation, to ultimate source of knowledge when it comes about the bot, using the handle @FromBotYam. Welcome to the Bot Yam documentation, to ultimate source of knowledge when it comes about the bot, using the handle @FromBotYam.
WARNING: Currently, the bot is operating under the Twitter API Elevated Access. On February 9th, new changes for the API access that has been announced will come into effect, and currently there isn't a guarantee that the bot will be up after the changes will be applied. !!! warning "Twitter API License Changes"
Currently, the bot is operating under the Twitter API Elevated Access. On February 9th, new changes for the API access that has been announced will come into effect, and currently there isn't a guarantee that the bot will be up after the changes will be applied.
Here you can have the syntax menu, but also read some information for nerds. Here you can have the syntax menu, but also read some information for nerds.

6
docs/files/usage.md
View file

@ -11,7 +11,8 @@ For example:
<blockquote class="twitter-tweet"><p lang="qme" dir="ltr"><a href="https://t.co/KSrhYS8clw">pic.twitter.com/KSrhYS8clw</a></p>&mdash; אני מבוט-ים (@FromBotYam) <a href="https://twitter.com/FromBotYam/status/1622255958901530628?ref_src=twsrc%5Etfw">February 5, 2023</a></blockquote> <script async src="https://platform.twitter.com/widgets.js" charset="utf-8"></script> <blockquote class="twitter-tweet"><p lang="qme" dir="ltr"><a href="https://t.co/KSrhYS8clw">pic.twitter.com/KSrhYS8clw</a></p>&mdash; אני מבוט-ים (@FromBotYam) <a href="https://twitter.com/FromBotYam/status/1622255958901530628?ref_src=twsrc%5Etfw">February 5, 2023</a></blockquote> <script async src="https://platform.twitter.com/widgets.js" charset="utf-8"></script>
NOTE: Be noted that the keywords **don't work in a match-case property**, which means that any way a certain keyword will be written in the post, it will trigger the bot. !!! note
Be noted that the keywords **don't work in a match-case property**, which means that any way a certain keyword will be written in the post, it will trigger the bot.
Victims Victims
------- -------
@ -181,7 +182,8 @@ None
אאא אאא
``` ```
NOTE: Yep. That's right. If you'll tag @FromBotYam with nothing on, you'll get the tilt gag. You have been warned. !!! note
Yep. That's right. If you'll tag @FromBotYam with nothing on, you'll get the tilt gag. You have been warned.
**The possible replies**: **The possible replies**:
<blockquote class="twitter-tweet" data-conversation="none"><p lang="iw" dir="rtl">סרבאאאקקקקקקק <a href="https://t.co/pnh4jveVRH">pic.twitter.com/pnh4jveVRH</a></p>&mdash; אני מבוט-ים (@FromBotYam) <a href="https://twitter.com/FromBotYam/status/1620403511102930945?ref_src=twsrc%5Etfw">January 31, 2023</a></blockquote> <script async src="https://platform.twitter.com/widgets.js" charset="utf-8"></script> <br> <blockquote class="twitter-tweet" data-conversation="none"><p lang="iw" dir="rtl">סרבאאאקקקקקקק <a href="https://t.co/pnh4jveVRH">pic.twitter.com/pnh4jveVRH</a></p>&mdash; אני מבוט-ים (@FromBotYam) <a href="https://twitter.com/FromBotYam/status/1620403511102930945?ref_src=twsrc%5Etfw">January 31, 2023</a></blockquote> <script async src="https://platform.twitter.com/widgets.js" charset="utf-8"></script> <br>