From 6a1b161d1e75df5d75e6fb6176870d2a05c136f8 Mon Sep 17 00:00:00 2001 From: Fabio Ivona Date: Mon, 15 Apr 2024 18:46:02 +0200 Subject: [PATCH] new docs --- docs/{0.introduction.md => 0.index.md} | 7 ++++--- docs/11.quickstart/1.new-bot.md | 8 ++++---- docs/11.quickstart/2.register-new-bot.md | 2 +- docs/11.quickstart/5.sending-a-message.md | 2 +- docs/12.features/3.keyboards.md | 2 +- docs/12.features/4.reply-keyboards.md | 2 +- docs/12.features/8.telegram-api-calls.md | 2 +- docs/13.models/2.telegraph-chat.md | 2 +- docs/14.webhooks/4.webhook-request-types.md | 2 +- 9 files changed, 15 insertions(+), 14 deletions(-) rename docs/{0.introduction.md => 0.index.md} (91%) diff --git a/docs/0.introduction.md b/docs/0.index.md similarity index 91% rename from docs/0.introduction.md rename to docs/0.index.md index 59155fd80..e666401cf 100644 --- a/docs/0.introduction.md +++ b/docs/0.index.md @@ -1,5 +1,5 @@ --- -title: 'Documentation' +title: 'Introduction' description: 'Telegraph is a Laravel package that enables easy Telegram Bots interaction' navigation.title: 'Introduction' --- @@ -12,10 +12,11 @@ navigation.title: 'Introduction' Static Analysis Total Downloads License -Twitter Follow +Twitter Follow -#### Telegraph is a Laravel package for fluently interacting with Telegram Bots made by +### Telegraph is a Laravel package for fluently interacting with Telegram Bots + ```php Telegraph::message('hello world') diff --git a/docs/11.quickstart/1.new-bot.md b/docs/11.quickstart/1.new-bot.md index 3b69a7980..314b8d57d 100644 --- a/docs/11.quickstart/1.new-bot.md +++ b/docs/11.quickstart/1.new-bot.md @@ -9,17 +9,17 @@ Go to the [@BotFather](https://t.me/botfather) app on Telegram. Send `/newbot`, to start creating a new Bot and setting its name and username. - + Take note of the bot `token`. - + ### Join groups permission To allow the bot to join Telegram groups, use the `/setjoingroups` command in @BotFather: - + ### Privacy Now you need to choose how much the bot will be able to read from the chats. Send `/setprivacy` command to @BotFather, and select your bot privacy: @@ -27,4 +27,4 @@ Now you need to choose how much the bot will be able to read from the chats. Sen - **enable**: to handle only `/` commands handling - **disable**: to allow the bot to read all messages sent to the chat - + diff --git a/docs/11.quickstart/2.register-new-bot.md b/docs/11.quickstart/2.register-new-bot.md index 95777335b..fbacc42c4 100644 --- a/docs/11.quickstart/2.register-new-bot.md +++ b/docs/11.quickstart/2.register-new-bot.md @@ -14,7 +14,7 @@ php artisan telegraph:new-bot ``` you will be guided through a bot creation wizard that will (optionally) allow you to add a new chat and setup a bot webhook as well - + ### programmatically diff --git a/docs/11.quickstart/5.sending-a-message.md b/docs/11.quickstart/5.sending-a-message.md index 38c179b46..1f1576ed4 100644 --- a/docs/11.quickstart/5.sending-a-message.md +++ b/docs/11.quickstart/5.sending-a-message.md @@ -14,7 +14,7 @@ use DefStudio\Telegraph\Models\TelegraphChat; $chat->html("Hello!\n\nI'm here!")->send(); ``` - + as an alternative, messages can be formatted with markdown: diff --git a/docs/12.features/3.keyboards.md b/docs/12.features/3.keyboards.md index 326a44ea8..5ef4b6283 100644 --- a/docs/12.features/3.keyboards.md +++ b/docs/12.features/3.keyboards.md @@ -5,7 +5,7 @@ navigation.title: 'Message Keyboards' A keyboard can be added to a message in order to offer a set of options to the user: - + ## Attaching a keyboard diff --git a/docs/12.features/4.reply-keyboards.md b/docs/12.features/4.reply-keyboards.md index 26a1f5595..d66f4480d 100644 --- a/docs/12.features/4.reply-keyboards.md +++ b/docs/12.features/4.reply-keyboards.md @@ -5,7 +5,7 @@ navigation.title: 'Reply Keyboards' When sending a message, Telegram can be instructed to replace the standard phone keyboard with a custom one (see [here](https://core.telegram.org/bots#keyboards) for detailed info): - + ## Attaching a keyboard diff --git a/docs/12.features/8.telegram-api-calls.md b/docs/12.features/8.telegram-api-calls.md index e63231fc9..ea8641887 100644 --- a/docs/12.features/8.telegram-api-calls.md +++ b/docs/12.features/8.telegram-api-calls.md @@ -57,7 +57,7 @@ Telegraph::bot($telegraphBot)->botUpdates(timeout: 60)->send(); Tells the chat users that something is happening on the bot's side. The status is set for up to 5 seconds or when a new message is received from the bot. - + ```php Telegraph::chatAction(ChatActions::TYPING)->send(); diff --git a/docs/13.models/2.telegraph-chat.md b/docs/13.models/2.telegraph-chat.md index 15ab0eceb..2e7281158 100644 --- a/docs/13.models/2.telegraph-chat.md +++ b/docs/13.models/2.telegraph-chat.md @@ -268,7 +268,7 @@ $telegraphChat->location(12.345, -54.321)->send(); Tells the chat users that something is happening on the bot's side. The status is set for up to 5 seconds or when a new message is received from the bot. - + ```php use DefStudio\Telegraph\Models\TelegraphChat; diff --git a/docs/14.webhooks/4.webhook-request-types.md b/docs/14.webhooks/4.webhook-request-types.md index 4001bca8e..e3af3bd72 100644 --- a/docs/14.webhooks/4.webhook-request-types.md +++ b/docs/14.webhooks/4.webhook-request-types.md @@ -117,7 +117,7 @@ class MyWebhookHandler extends WebhookHandler Bots messages may ship with keyboard of buttons that trigger actions when pressed: - + when pressed, a new call will be forwarded to the webhook with the following payload