Skip to content

Commit 2be1c1d

Browse files
committed
➕ Added official docs
1 parent f2635ae commit 2be1c1d

File tree

7 files changed

+18
-18
lines changed

7 files changed

+18
-18
lines changed

docs/examples/inline_bot.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -79,7 +79,7 @@ bot.onMessage(filter -> filter.commands("start"), (context, message) -> {
7979
- The empty string `""` means no pre-filled query text
8080

8181
**Result:**
82-
<img src="img/i1.png">
82+
<img src="telebof/img/i1.png">
8383

8484
---
8585

@@ -111,7 +111,7 @@ bot.onInline(filter -> filter.emptyQuery(), (context, query) -> {
111111
- `InputTextMessageContent("Write something")` is the message that will be sent if the user selects this result
112112
- `answerInlineQuery()` sends the results back to Telegram for display
113113

114-
<img src="img/i2.jpg">
114+
<img src="telebof/img/i2.jpg">
115115

116116
---
117117

@@ -145,7 +145,7 @@ bot.onInline(_ -> true, (context, query) -> {
145145
**User Experience:**
146146
When users type `@botusername some text`, they see a result that says "some text" and can send a message saying "You said: some text".
147147

148-
<img src="img/i3.jpg"> <img src="img/i4.png">
148+
<img src="telebof/img/i3.jpg"> <img src="telebof/img/i4.png">
149149
---
150150

151151
**Final Complete Code**

docs/examples/inline_keyboard_bot.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -90,7 +90,7 @@ Each `InlineKeyboardButton` takes two parameters:
9090
**Visual Result:**<br>
9191
The user sees a message with three colorful buttons below it that they can interact with.
9292

93-
<img src="img/ik1.png">
93+
<img src="telebof/img/ik1.png">
9494

9595
---
9696

docs/examples/keyboard_bot.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -68,17 +68,17 @@ bot.onMessage(filter -> filter.commands("start"), (context, message) -> {
6868

6969
**Result without `replyMarkup`:**
7070

71-
<img src="img/k1.png">
71+
<img src="telebof/img/k1.png">
7272

7373

7474
**Result with `replyMarkup` but without `resizeKeyboard`:**
7575

76-
<img src="img/k2.png">
76+
<img src="telebof/img/k2.png">
7777

7878

7979
**Final result with both `replyMarkup` and `resizeKeyboard(true)`:**
8080

81-
<img src="img/k3.png">
81+
<img src="telebof/img/k3.png">
8282

8383
---
8484

@@ -202,4 +202,4 @@ This bot demonstrates how to:
202202
**The full source code can be found on** [examples/keyboard_bot](https://github.com/natanimn/telebof/blob/main/examples/long-polling/src/main/java/io/github/natanimn/KeyboardBot.java)
203203

204204
**Final result showing the interaction flow:**
205-
<img src="img/k4.png">
205+
<img src="telebof/img/k4.png">

docs/examples/media_downloader.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -108,7 +108,7 @@ private void start(BotContext context, Message message){
108108
}
109109
```
110110

111-
<img src="img/md1.png">
111+
<img src="telebof/img/md1.png">
112112
---
113113

114114
**Handle media download when user sends photos, videos, GIFs, or audio**
@@ -202,7 +202,7 @@ context.sendMessage(message.chat.id, String.format("Send <code>/%s_%s</code> to
202202
This provides the user with a specific command they can use later to retrieve this exact media file.
203203

204204

205-
<img src="img/md2.png">
205+
<img src="telebof/img/md2.png">
206206
---
207207

208208
**Handle media retrieval using special commands**
@@ -270,7 +270,7 @@ public static void main(String[] args){
270270
}
271271
```
272272

273-
<img src="img/md3.png">
273+
<img src="telebof/img/md3.png">
274274

275275
---
276276

docs/examples/payment_bot.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -67,7 +67,7 @@ static void start(BotContext context, Message message){
6767
bot.onMessage(filter -> filter.commands("start"), PaymentExampleBot::start);
6868
```
6969

70-
<img src="img/p1.png">
70+
<img src="telebof/img/p1.png">
7171

7272

7373
---
@@ -106,7 +106,7 @@ static void pay(BotContext context, Message message){
106106
bot.onMessage(filter -> filter.commands("pay"), PaymentExampleBot::pay);
107107
```
108108

109-
<img src="img/p2.png">
109+
<img src="telebof/img/p2.png">
110110

111111
---
112112

@@ -205,7 +205,7 @@ public static void main(String[] args){
205205
}
206206
```
207207

208-
<img src="img/p3.png">
208+
<img src="telebof/img/p3.png">
209209

210210
---
211211

docs/examples/state_bot.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -163,7 +163,7 @@ private void cancel(BotContext ctx, Message message){
163163
- `clearState(user_id)` removes both the state marker and any associated data
164164

165165

166-
<img src="img/s2.png">
166+
<img src="telebof/img/s2.png">
167167

168168
---
169169

@@ -185,7 +185,7 @@ public static void main(String[] args){
185185

186186
## Conversation Flow Example
187187

188-
<img src="img/s1.png">
188+
<img src="telebof/img/s1.png">
189189

190190
1. User sends `/start` → Bot sets state to `"name"` and asks for name
191191
2. User provides name → Bot stores name, sets state to `"age"`, asks for age

docs/examples/welcome_bot.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -81,7 +81,7 @@ private void startPrivate(BotContext context, Message message){
8181
bot.onMessage(filter -> filter.commands("start") && filter.Private(), this::startPrivate);
8282
```
8383

84-
<img src="img/w1.png">
84+
<img src="telebof/img/w1.png">
8585

8686

8787
---
@@ -133,7 +133,7 @@ private void botPromoted(BotContext context, ChatMemberUpdated member){
133133
bot.onMyChatMember(_ -> true, this::botPromoted);
134134
```
135135

136-
<img src="img/w2.png">
136+
<img src="telebof/img/w2.png">
137137

138138
---
139139

0 commit comments

Comments
 (0)