diff --git a/Docs-Overhaul.md b/Docs-Overhaul.md new file mode 100644 index 0000000..b56b885 --- /dev/null +++ b/Docs-Overhaul.md @@ -0,0 +1,38 @@ +The docs are not perfect. Please edit this page with any suggestion you can have to improve them. + +First of all, [people struggle a lot with entities](https://t.me/TelethonChat/97160) and that should be addressed. People also [must understand the importance of input entities](https://t.me/TelethonChat/98153), because it matters a lot. + +When getting started and moving to the next page, [a lighter installation page](https://t.me/telethonofftopic/144457) could help, and move installing from source stuff later. + +[A suggestion for the new structure](https://t.me/telethonofftopic/144473) looks like this: +```markdown +# Cheat Sheet +## Initialising Client + from Telethon import TelegramClient + client = TelegramClient(...) + with client: + ... + +## Entities +An entity object contains the following... + id: ID of user + username: Username of user + access_hash: + +## Errors +`FloodWaitError`: Request made too often... + +... +``` + +[Another suggestion](https://t.me/telethonofftopic/144479) could [look like the following](https://t.me/telethonofftopic/144486): +```markdown +# Quickstart +## Installation (brief) +## Creating a Client +## ??? + +# Dive In +## Installing from Source +## ??? +``` \ No newline at end of file