Merge pull request #574 from defstudio/new-docs

New docs
defstudio · Apr 15, 2024 · d9c4019 · d9c4019
2 parents ded0109 + 6302898
commit d9c4019
Show file tree

Hide file tree

Showing 67 changed files with 19 additions and 17,183 deletions.
diff --git a/.github/workflows/docs.yml b/.github/workflows/docs.yml
diff --git a/README.md b/README.md
@@ -49,7 +49,7 @@ php artisan vendor:publish --tag="telegraph-translations"
 
 ## Usage & Documentation
 
-After a new bot is created and added to a chat/group/channel (as described [in our documentation](https://defstudio.github.io/telegraph/quickstart/new-bot)),
+After a new bot is created and added to a chat/group/channel (as described [in our documentation](https://docs.defstudio.dev/telegraph/quickstart/new-bot)),
 the `Telegraph` facade can be used to easily send messages and interact with it:
 
 ```php
@@ -58,7 +58,7 @@ Telegraph::message('this is great')->send();
 
 An extensive documentation is available at
 
-https://defstudio.github.io/telegraph
+https://docs.defstudio.dev
 
 ## Testing
 

diff --git a/config/telegraph.php b/config/telegraph.php
@@ -26,7 +26,7 @@
          * Sets the handler to be used when Telegraph
          * receives a new webhook call.
          *
-         * For reference, see https://defstudio.github.io/telegraph/webhooks/overview
+         * For reference, see https://docs.defstudio.dev/telegraph/webhooks/overview
          */
         'handler' => DefStudio\Telegraph\Handlers\EmptyWebhookHandler::class,
 

diff --git a/docs/.eslintignore b/docs/.eslintignore
diff --git a/docs/.eslintrc.cjs b/docs/.eslintrc.cjs
diff --git a/docs/.gitignore b/docs/.gitignore
diff --git a/docs/.npmrc b/docs/.npmrc
diff --git a/docs/content/0.index.md → docs/0.index.md b/docs/content/0.index.md → 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'
 <a href="https://github.com/defstudio/telegraph/actions?query=workflow%3Aphpstan+branch%3Amain" target="_blank"><img style="display: inline-block; margin-top: 0.5em; margin-bottom: 0.5em" src="https://img.shields.io/github/actions/workflow/status/defstudio/telegraph/phpstan.yml?branch=main&label=phpstan&cacheSeconds=3600" alt="Static Analysis"></a>
 <a href="https://packagist.org/packages/defstudio/telegraph" target="_blank"><img style="display: inline-block; margin-top: 0.5em; margin-bottom: 0.5em" src="https://img.shields.io/packagist/dt/defstudio/telegraph.svg?style=flat&cacheSeconds=3600" alt="Total Downloads"></a>
 <a href="https://packagist.org/packages/defstudio/telegraph" target="_blank"><img style="display: inline-block; margin-top: 0.5em; margin-bottom: 0.5em" src="https://img.shields.io/packagist/l/defstudio/telegraph?style=flat&cacheSeconds=3600" alt="License"></a>
-<a href="https://twitter.com/FabioIvona?ref_src=twsrc%5Etfw"><img alt="Twitter Follow" src="https://img.shields.io/twitter/follow/FabioIvona?label=Follow&style=social"></a>
+<a href="https://twitter.com/FabioIvona?ref_src=twsrc%5Etfw" target="_blank"><img style="display: inline-block; margin-top: 0.5em; margin-bottom: 0.5em" alt="Twitter Follow" src="https://img.shields.io/twitter/follow/FabioIvona?label=Follow&style=social"></a>
 
 
-#### 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/content/1.about-us.md → docs/1.about-us.md b/docs/content/1.about-us.md → docs/1.about-us.md
diff --git a/docs/content/11.quickstart/1.new-bot.md → docs/11.quickstart/1.new-bot.md b/docs/content/11.quickstart/1.new-bot.md → docs/11.quickstart/1.new-bot.md
@@ -9,22 +9,22 @@ 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.
 
-<img src="/screenshots/new-bot.jpg" />
+<img src="/img/screenshots/new-bot.jpg" />
 
 Take note of the bot `token`.
 
-<img src="/screenshots/new-bot-token.jpg" />
+<img src="/img/screenshots/new-bot-token.jpg" />
 
 ### Join groups permission
 
 To allow the bot to join Telegram groups, use the `/setjoingroups` command in @BotFather:
 
-<img src="/screenshots/new-bot-joingroups.jpg" />
+<img src="/img/screenshots/new-bot-joingroups.jpg" />
 
 ### 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:
 
 - **enable**: to handle only `/` commands handling
 - **disable**: to allow the bot to read all messages sent to the chat
 
-  <img src="/screenshots/new-bot-setprivacy.jpg" />
+  <img src="/img/screenshots/new-bot-setprivacy.jpg" />
diff --git a/...ntent/11.quickstart/2.register-new-bot.md → docs/11.quickstart/2.register-new-bot.md b/...ntent/11.quickstart/2.register-new-bot.md → 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
 
-<img src="/screenshots/artisan-new-bot.jpg" />
+<img src="/img/screenshots/artisan-new-bot.jpg" />
 
 ### programmatically
 

diff --git a/...ontent/11.quickstart/3.setting-webhook.md → docs/11.quickstart/3.setting-webhook.md b/...ontent/11.quickstart/3.setting-webhook.md → docs/11.quickstart/3.setting-webhook.md
diff --git a/...tent/11.quickstart/4.register-new-chat.md → docs/11.quickstart/4.register-new-chat.md b/...tent/11.quickstart/4.register-new-chat.md → docs/11.quickstart/4.register-new-chat.md
diff --git a/...tent/11.quickstart/5.sending-a-message.md → docs/11.quickstart/5.sending-a-message.md b/...tent/11.quickstart/5.sending-a-message.md → docs/11.quickstart/5.sending-a-message.md
@@ -14,7 +14,7 @@ use DefStudio\Telegraph\Models\TelegraphChat;
 $chat->html("<strong>Hello!</strong>\n\nI'm here!")->send();
 ```
 
-<img src="/screenshots/first-message.png" />
+<img src="/img/screenshots/first-message.png" />
 
 as an alternative, messages can be formatted with markdown:
 

diff --git a/docs/content/12.features/1.messages.md → docs/12.features/1.messages.md b/docs/content/12.features/1.messages.md → docs/12.features/1.messages.md
diff --git a/...content/12.features/2.telegraph-facade.md → docs/12.features/2.telegraph-facade.md b/...content/12.features/2.telegraph-facade.md → docs/12.features/2.telegraph-facade.md
diff --git a/docs/content/12.features/3.keyboards.md → docs/12.features/3.keyboards.md b/docs/content/12.features/3.keyboards.md → 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:
 
-<img src="/screenshots/keyboard-example.png" />
+<img src="/img/screenshots/keyboard-example.png" />
 
 ## Attaching a keyboard
 

diff --git a/.../content/12.features/4.reply-keyboards.md → docs/12.features/4.reply-keyboards.md b/.../content/12.features/4.reply-keyboards.md → 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):
 
-<img src="/screenshots/reply-keyboard.jpeg" />
+<img src="/img/screenshots/reply-keyboard.jpeg" />
 
 ## Attaching a keyboard
 

diff --git a/.../content/12.features/5.queued-messages.md → docs/12.features/5.queued-messages.md b/.../content/12.features/5.queued-messages.md → docs/12.features/5.queued-messages.md
diff --git a/...ntent/12.features/6.telegraph-response.md → docs/12.features/6.telegraph-response.md b/...ntent/12.features/6.telegraph-response.md → docs/12.features/6.telegraph-response.md
diff --git a/docs/content/12.features/7.attachments.md → docs/12.features/7.attachments.md b/docs/content/12.features/7.attachments.md → docs/12.features/7.attachments.md
diff --git a/...ntent/12.features/8.telegram-api-calls.md → docs/12.features/8.telegram-api-calls.md b/...ntent/12.features/8.telegram-api-calls.md → 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.
 
-<img src="/screenshots/chat-action.png" />
+<img src="/img/screenshots/chat-action.png" />
 
 ```php
 Telegraph::chatAction(ChatActions::TYPING)->send();

diff --git a/docs/content/12.features/9.dto.md → docs/12.features/9.dto.md b/docs/content/12.features/9.dto.md → docs/12.features/9.dto.md
diff --git a/docs/content/13.models/1.telegraph-bot.md → docs/13.models/1.telegraph-bot.md b/docs/content/13.models/1.telegraph-bot.md → docs/13.models/1.telegraph-bot.md
diff --git a/docs/content/13.models/2.telegraph-chat.md → docs/13.models/2.telegraph-chat.md b/docs/content/13.models/2.telegraph-chat.md → 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.
 
-<img src="screenshots/chat-action.png" />
+<img src=/img/screenshots/chat-action.png" />
 
 ```php
 use DefStudio\Telegraph\Models\TelegraphChat;

diff --git a/docs/content/14.webhooks/1.overview.md → docs/14.webhooks/1.overview.md b/docs/content/14.webhooks/1.overview.md → docs/14.webhooks/1.overview.md
diff --git a/...ent/14.webhooks/2.registering-webhooks.md → docs/14.webhooks/2.registering-webhooks.md b/...ent/14.webhooks/2.registering-webhooks.md → docs/14.webhooks/2.registering-webhooks.md
diff --git a/...ontent/14.webhooks/3.deleting-webhooks.md → docs/14.webhooks/3.deleting-webhooks.md b/...ontent/14.webhooks/3.deleting-webhooks.md → docs/14.webhooks/3.deleting-webhooks.md
diff --git a/...nt/14.webhooks/4.webhook-request-types.md → docs/14.webhooks/4.webhook-request-types.md b/...nt/14.webhooks/4.webhook-request-types.md → 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:
 
-<img src="screenshots/keyboard-example.png" />
+<img src=/img/screenshots/keyboard-example.png" />
 
 when pressed, a new call will be forwarded to the webhook with the following payload
 

diff --git a/docs/content/14.webhooks/5.callback-data.md → docs/14.webhooks/5.callback-data.md b/docs/content/14.webhooks/5.callback-data.md → docs/14.webhooks/5.callback-data.md
diff --git a/docs/content/14.webhooks/6.callback-reply.md → docs/14.webhooks/6.callback-reply.md b/docs/content/14.webhooks/6.callback-reply.md → docs/14.webhooks/6.callback-reply.md
diff --git a/...ent/14.webhooks/7.keyboard-interaction.md → docs/14.webhooks/7.keyboard-interaction.md b/...ent/14.webhooks/7.keyboard-interaction.md → docs/14.webhooks/7.keyboard-interaction.md
diff --git a/docs/content/14.webhooks/8.manual-polling.md → docs/14.webhooks/8.manual-polling.md b/docs/content/14.webhooks/8.manual-polling.md → docs/14.webhooks/8.manual-polling.md
diff --git a/.../content/15.storage/1.entities_storage.md → docs/15.storage/1.entities_storage.md b/.../content/15.storage/1.entities_storage.md → docs/15.storage/1.entities_storage.md
diff --git a/docs/content/16.testing/1.fake.md → docs/16.testing/1.fake.md b/docs/content/16.testing/1.fake.md → docs/16.testing/1.fake.md
diff --git a/docs/content/16.testing/2.assertions.md → docs/16.testing/2.assertions.md b/docs/content/16.testing/2.assertions.md → docs/16.testing/2.assertions.md
diff --git a/docs/content/17.community/1.releases.md → docs/17.community/1.releases.md b/docs/content/17.community/1.releases.md → docs/17.community/1.releases.md
diff --git a/docs/content/2.installation.md → docs/2.installation.md b/docs/content/2.installation.md → docs/2.installation.md
@@ -58,7 +58,7 @@ return [
          * Sets the handler to be used when Telegraph
          * receives a new webhook call.
          *
-         * For reference, see https://defstudio.github.io/telegraph/webhooks/overview
+         * For reference, see https://docs.defstudio.dev/telegraph/webhooks/overview
          */
         'handler' => DefStudio\Telegraph\Handlers\EmptyWebhookHandler::class,
 

diff --git a/docs/content/3.issues.md → docs/3.issues.md b/docs/content/3.issues.md → docs/3.issues.md
diff --git a/docs/content/4.support-us.md → docs/4.support-us.md b/docs/content/4.support-us.md → docs/4.support-us.md
diff --git a/docs/README.md b/docs/README.md
diff --git a/docs/app.config.ts b/docs/app.config.ts
diff --git a/docs/public/preview-dark.png → docs/img/preview-dark.png b/docs/public/preview-dark.png → docs/img/preview-dark.png
diff --git a/docs/public/preview.png → docs/img/preview.png b/docs/public/preview.png → docs/img/preview.png
diff --git a/docs/public/screenshots/artisan-new-bot.jpg → docs/img/screenshots/artisan-new-bot.jpg b/docs/public/screenshots/artisan-new-bot.jpg → docs/img/screenshots/artisan-new-bot.jpg
diff --git a/docs/public/screenshots/chat-action.png → docs/img/screenshots/chat-action.png b/docs/public/screenshots/chat-action.png → docs/img/screenshots/chat-action.png
diff --git a/docs/public/screenshots/first-message.png → docs/img/screenshots/first-message.png b/docs/public/screenshots/first-message.png → docs/img/screenshots/first-message.png
diff --git a/docs/public/screenshots/keyboard-example.png → docs/img/screenshots/keyboard-example.png b/docs/public/screenshots/keyboard-example.png → docs/img/screenshots/keyboard-example.png
diff --git a/...lic/screenshots/message-with-keyboard.png → ...img/screenshots/message-with-keyboard.png b/...lic/screenshots/message-with-keyboard.png → ...img/screenshots/message-with-keyboard.png
diff --git a/...public/screenshots/new-bot-joingroups.jpg → docs/img/screenshots/new-bot-joingroups.jpg b/...public/screenshots/new-bot-joingroups.jpg → docs/img/screenshots/new-bot-joingroups.jpg
diff --git a/...public/screenshots/new-bot-setprivacy.jpg → docs/img/screenshots/new-bot-setprivacy.jpg b/...public/screenshots/new-bot-setprivacy.jpg → docs/img/screenshots/new-bot-setprivacy.jpg
diff --git a/docs/public/screenshots/new-bot-token.jpg → docs/img/screenshots/new-bot-token.jpg b/docs/public/screenshots/new-bot-token.jpg → docs/img/screenshots/new-bot-token.jpg
diff --git a/docs/public/screenshots/new-bot.jpg → docs/img/screenshots/new-bot.jpg b/docs/public/screenshots/new-bot.jpg → docs/img/screenshots/new-bot.jpg
diff --git a/docs/public/screenshots/reply-keyboard.jpeg → docs/img/screenshots/reply-keyboard.jpeg b/docs/public/screenshots/reply-keyboard.jpeg → docs/img/screenshots/reply-keyboard.jpeg
diff --git a/docs/nuxt.config.ts b/docs/nuxt.config.ts