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

3
Architecture.md Normal file

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

14
Home.md

@ -3,7 +3,7 @@
- [x] `JobQueue` - [x] `JobQueue`
- [x] Tutorial your first bot - [x] Tutorial your first bot
- [x] inline keyboard example - [x] inline keyboard example
- [ ] performance optimization - extract the asyncio related things to a standalone page - [x] performance optimizationstandalone page
- [x] Type checking - [x] Type checking
- [x] types of handlers - [x] types of handlers
- [x] webhooks - [x] webhooks
@ -13,13 +13,11 @@ Other todo:
- [ ] new page on general architecture overview - [ ] new page on general architecture overview
- [ ] Link to the architecture diagram once that's contained in the v14/master branch - [ ] 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/) [![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 ## 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 🙂 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. 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 ### Code Resources

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