From 3292fdd2256c0029f6b4254c9a4ed42a118deedc Mon Sep 17 00:00:00 2001 From: shiqera Date: Mon, 17 Nov 2025 15:14:10 +0300 Subject: [PATCH] fix invalid urls/names in readme & docs --- docs/01-your-first-bot.md | 4 ++-- docs/02-listen-and-respond.md | 6 +++--- docs/03-attachments.md | 2 +- readme.md | 6 +++--- 4 files changed, 9 insertions(+), 9 deletions(-) diff --git a/docs/01-your-first-bot.md b/docs/01-your-first-bot.md index 3b041ed..edd43e4 100644 --- a/docs/01-your-first-bot.md +++ b/docs/01-your-first-bot.md @@ -1,8 +1,8 @@ # `1` Ваш первый бот -Для начала вам нужно получить токен бота. Для этого откройте диалог с [PrimeBot](https://max.ru/primebot) и создайте нового бота, следуя инструкциям. После этого PrimeBot отправит вам токен. +Для начала вам нужно получить токен бота. Для этого откройте диалог с [MasterBot](https://max.ru/masterbot) и создайте нового бота, следуя инструкциям. После этого MasterBot отправит вам токен. -Создайте новый проект и установите `one-me-bot-api`. Для этого откройте терминал и выполните следующие команды: +Создайте новый проект и установите `max-bot-api`. Для этого откройте терминал и выполните следующие команды: ```sh # Создайте новую папку и перейдите в неё mkdir my-first-bot diff --git a/docs/02-listen-and-respond.md b/docs/02-listen-and-respond.md index 72f6c20..e9a1276 100644 --- a/docs/02-listen-and-respond.md +++ b/docs/02-listen-and-respond.md @@ -1,7 +1,7 @@ # `2` Прослушивание обновлений и реакция на них После запуска бота Max начнёт отправлять вам обновления. -> Подробности обо всех обновлениях смотрите в [официальной документации](https://dev.max.ru/). +> Подробности обо всех обновлениях смотрите в [официальной документации](https://dev.max.ru/docs-api). Max Bot API позволяет прослушивать эти обновления, например: ```typescript @@ -54,7 +54,7 @@ console.log(message.body.mid); ``` > ℹ️ Если Max Bot API ещё не поддерживает какой-то метод, то вы можете вызвать его через `ctx.api.raw` > -> Методы raw api имеют следующуй формат: +> Методы raw api имеют следующий формат: > ```typescript > ctx.api.raw.get('method', {/* параметры запроса */}); > ctx.api.raw.post('method', {/* параметры запроса */}); @@ -82,7 +82,7 @@ bot.hears('ping', async (ctx) => { ``` ## Форматирование сообщений -> Подробности про форматирование смотрите в [официальной документации](https://dev.max.ru/). +> Подробности про форматирование смотрите в [официальной документации](https://dev.max.ru/docs-api). Вы можете отправлять сообщения, используя **жирный** или _курсивный_ текст, ссылки и многое другое. Есть два типа форматирования: `markdown` и `html`. #### Markdown diff --git a/docs/03-attachments.md b/docs/03-attachments.md index 49a3908..e3eb635 100644 --- a/docs/03-attachments.md +++ b/docs/03-attachments.md @@ -38,7 +38,7 @@ await ctx.reply('Это фото загружено из файла', { ### При помощи ссылки Пока что доступно только для изображений: ```typescript -const image = await ctx.api.uploadImage({ url: 'https://upload.wikimedia.org/wikipedia/commons/Image.png' }); +const image = await ctx.api.uploadImage({ url: 'https://max.ru/s/img/big-logo.png' }); await ctx.reply('', { attachments: [image.toJson()] }); ``` diff --git a/readme.md b/readme.md index 3cbe7fa..7570472 100644 --- a/readme.md +++ b/readme.md @@ -2,11 +2,11 @@ ## Документация -В [документации](https://github.com/max-messenger/max-bot-api-client-ts/tree/master/docs) вы можете найти подробные инструкции по использованию фреймворка. +В [документации](https://github.com/max-messenger/max-bot-api-client-ts/tree/main/docs) вы можете найти подробные инструкции по использованию фреймворка. ## Быстрый старт -> Если вы новичок, то можете прочитать [официальную документацию](https://dev.max.ru/), написанную разработчиками Max +> Если вы новичок, то можете прочитать [официальную документацию](https://dev.max.ru/), написанную разработчиками Max. ### Получение токена Откройте диалог с [Master Bot](https://max.ru/masterbot), следуйте инструкциям и создайте нового бота. После создания бота Master Bot отправит вам токен. @@ -59,4 +59,4 @@ bot.start(); > ⚠️ Завершайте работу программы при неизвестных ошибках, иначе бот может зависнуть в состоянии ошибки. -> ℹ️ [`pm2`](https://pm2.keymetrics.io/) может автоматически перезапустить вашего бота, если он остановится по какой-либо причине +> ℹ️ [`pm2`](https://pm2.keymetrics.io/) может автоматически перезапустить вашего бота, если он остановится по какой-либо причине.