OpenSource/python-telegram-bot
OpenSource/python-telegram-bot
1
0
Fork 0
mirror of https://github.com/python-telegram-bot/python-telegram-bot.git synced 2024-10-23 17:36:26 +02:00
Code Issues Projects Releases Packages Wiki Activity

Update the sidebar a bit

Hinrich Mahler 2022-04-22 20:53:23 +02:00
parent be52c625af
commit 5d1c942dd9
3 changed files with 39 additions and 21 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

3
Architecture.md Normal file

@ -0,0 +1,3 @@
# Architecture
> Here be text

14
Home.md

@ -3,7 +3,7 @@
- [x] `JobQueue`
- [x] Tutorial your first bot
- [x] inline keyboard example
- [ ] performance optimization - extract the asyncio related things to a standalone page
- [x] performance optimizationstandalone page
- [x] Type checking
- [x] types of handlers
- [x] webhooks
@ -13,13 +13,11 @@ Other todo:
- [ ] new page on general architecture overview
- [ ] Link to the architecture diagram once that's contained in the v14/master branch
- [ ] new write up for the `Concurrency` page - for now I just copied the `multithreading` stuff from the v13 Performance Optimizations page
[![Logo](https://github.com/python-telegram-bot/logos/raw/master/logo-text/png/ptb-logo-text_768.png)](https://python-telegram-bot.org/)
## About this Wiki
For a long time, our documentation consisted of our [API documentation](http://python-telegram-bot.readthedocs.io/) and README. As a result, the README became simply too big to be useful. In an effort to change that, we moved large parts of our README into different Wiki articles. In the process, we improved the texts with additional information, clearer wording and some cross-references.
## Contributing to this Wiki
If you stumble upon a part of the wiki that is unclear or missing important points, please go ahead and drop us a message in our [Telegram Group](https://t.me/pythontelegrambotgroup), or just edit the part yourself (anyone can contribute). We'd like our wiki to be as complete as possible 🙂
@ -32,9 +30,13 @@ In the sidebar to the right, you can find all important pages of this wiki. They
Introductory articles and frequently referenced pages.
### PTB Features & Concepts
### Concepts & Important Elements
Introductions & explanations of the different components the powerful `telegram.ext` offers.
Introductions & explanations of how the components of `telegram.ext` work and interact with each other.
### Notable Features
Elaborate explanation to more advanced features of `telegram.ext`.
### Code Resources

43
_Sidebar.md

@ -1,39 +1,50 @@
## Must read
1. [[Introduction to the API|Introduction-to-the-API]]
2. [[Tutorial: Your first bot|Extensions-–-Your-first-Bot]]
3. [[FAQ|Frequently-Asked-Questions]]
4. [[How to ask good questions|Ask-Right]]
5. [[How to write an MWE|MWE]]
## PTB Features & Concepts
1. [[Builder Pattern|Builder-Pattern]]
2. [[Types of Handlers|Types-Of-Handlers]]
3. [[Advanced Filters|Extensions-–-Advanced-Filters]]
4. [[Storing data|Storing-bot,-user-and-chat-related-data]]
5. [[Making your bot persistent|Making-your-bot-persistent]]
6. [[Adding Defaults|Adding-defaults-to-your-bot]]
7. [[Exceptions, Warnings and Logging|Exceptions, Warnings and Logging]]
8. [[Job Queue|Extensions-–-JobQueue]]
9. [Arbitrary `callback_data`](Arbitrary-callback_data)
10. [[Avoiding flood limits|Avoiding-flood-limits]]
## Concepts & Important Elements
1. [[Architecture Overview|Architecture]]
2. [Builder Pattern for `Application`](Builder-Pattern)
3. [[Types of Handlers|Types-Of-Handlers]]
4. [[Exceptions, Warnings and Logging|Exceptions, Warnings and Logging]]
5. [[Concurrency in PTB|Concurrency]]
## Notable Features
1. [[Advanced Filters|Extensions-–-Advanced-Filters]]
2. [[Storing data|Storing-bot,-user-and-chat-related-data]]
3. [[Making your bot persistent|Making-your-bot-persistent]]
4. [[Adding Defaults|Adding-defaults-to-your-bot]]
5. [[Job Queue|Extensions-–-JobQueue]]
6. [Arbitrary `callback_data`](Arbitrary-callback_data)
7. [[Avoiding flood limits|Avoiding-flood-limits]]
8. [[Webhooks|Webhooks]]
## Code Resources
1. [[Frequently requested design patterns|Frequently-requested-design-patterns]]
2. [[Code snippets|Code-snippets]]
3. [[Performance Optimizations|Performance-Optimizations]]
4. [[Webhooks|Webhooks]]
5. [[Telegram Passport|Telegram-Passport]]
6. [[Bots built with PTB|Bots-built-with-PTB]]
7. [[Automated Bot Tests|Writing-Tests]]
4. [[Telegram Passport|Telegram-Passport]]
5. [[Bots built with PTB|Bots-built-with-PTB]]
6. [[Automated Bot Tests|Writing-Tests]]
## Examples explained
1. [[InlineKeyboard Example|InlineKeyboard-Example]]
## Networking
1. [[Working Behind a Proxy|Working-Behind-a-Proxy]]
2. [[Handling network errors|Handling-network-errors]]
## Other resources
1. [[Where to host Telegram Bots|Where-to-host-Telegram-Bots]]
2. [[How to host your bot|Hosting-your-bot]]
3. [[Local API Server|Local-Bot-API-Server]]
@ -44,6 +55,7 @@
8. [[Emoji|Emoji]]
## Transition Guides
- [[Version 4|Transition-guide-to-Version-4.0]]
- [[Version 5|Transition-guide-to-Version-5.0]]
- [[Version 12|Transition-guide-to-Version-12.0]]
@ -51,6 +63,7 @@
- [[Version 14|Transition-guide-to-Version-14.0]]
## Administration
- [[Test Bots|Internal-test-bots]]
- [[How To Release|Releasing-a-new-version]]
- [[Bots, Groups & Channels|Project-Bots,-Groups-and-Channels]]