Skip to content

Commit 3a0d0d2

Browse files
author
Ben Brown
committed
updates to docs
add starterkits readme
1 parent d4801a4 commit 3a0d0d2

14 files changed

+69
-18
lines changed

‎docs/middleware.md

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -178,18 +178,19 @@ controller.middleware.capture.use(function(bot, message, convo, next) {
178178

179179
});
180180
```
181-
182-
## Botkit Documentation Index
181+
## Documentation
183182

184183
* [Get Started](readme.md)
185184
* [Botkit Studio API](readme-studio.md)
186185
* [Function index](readme.md#developing-with-botkit)
186+
* [Starter Kits](readme-starterkits.md)
187187
* [Extending Botkit with Plugins and Middleware](middleware.md)
188188
* [Message Pipeline](readme-pipeline.md)
189189
* [List of current plugins](readme-middlewares.md)
190190
* [Storing Information](storage.md)
191191
* [Logging](logging.md)
192192
* Platforms
193+
* [Web and Apps](readme-web.md)
193194
* [Slack](readme-slack.md)
194195
* [Cisco Spark](readme-ciscospark.md)
195196
* [Microsoft Teams](readme-teams.md)

‎docs/readme-botframework.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -207,11 +207,12 @@ You can easily turn on the typing indicator on platforms that support that behav
207207
bot.reply(message, { type: "typing" });
208208
~~~
209209

210-
## Botkit Documentation Index
210+
## Documentation
211211

212212
* [Get Started](readme.md)
213213
* [Botkit Studio API](readme-studio.md)
214214
* [Function index](readme.md#developing-with-botkit)
215+
* [Starter Kits](readme-starterkits.md)
215216
* [Extending Botkit with Plugins and Middleware](middleware.md)
216217
* [Message Pipeline](readme-pipeline.md)
217218
* [List of current plugins](readme-middlewares.md)

‎docs/readme-ciscospark.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -253,12 +253,12 @@ controller.on('bot_space_join', function(bot, message) {
253253
});
254254
~~~
255255

256-
257-
## Botkit Documentation Index
256+
## Documentation
258257

259258
* [Get Started](readme.md)
260259
* [Botkit Studio API](readme-studio.md)
261260
* [Function index](readme.md#developing-with-botkit)
261+
* [Starter Kits](readme-starterkits.md)
262262
* [Extending Botkit with Plugins and Middleware](middleware.md)
263263
* [Message Pipeline](readme-pipeline.md)
264264
* [List of current plugins](readme-middlewares.md)

‎docs/readme-facebook.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -830,12 +830,12 @@ Instead of the web server generated with setupWebserver(), it is possible to use
830830

831831
Here is an example of [using an Express web server alongside BotKit for Facebook Messenger](https://github.com/mvaragnat/botkit-messenger-express-demo).
832832

833-
834-
## Botkit Documentation Index
833+
## Documentation
835834

836835
* [Get Started](readme.md)
837836
* [Botkit Studio API](readme-studio.md)
838837
* [Function index](readme.md#developing-with-botkit)
838+
* [Starter Kits](readme-starterkits.md)
839839
* [Extending Botkit with Plugins and Middleware](middleware.md)
840840
* [Message Pipeline](readme-pipeline.md)
841841
* [List of current plugins](readme-middlewares.md)

‎docs/readme-middlewares.md

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -53,21 +53,24 @@ These plugins help you measure the success of your bots, across a variety of mea
5353
# Have you created middleware?
5454
We would love to hear about it! [Contact the Howdy team](https://howdy.ai/) to be included in Botkit documentation, or [submit a PR on this documentation](https://github.com/howdyai/botkit-storage-firebase/blob/master/CONTRIBUTING.md)!
5555

56-
5756
## Documentation
5857

5958
* [Get Started](readme.md)
6059
* [Botkit Studio API](readme-studio.md)
6160
* [Function index](readme.md#developing-with-botkit)
61+
* [Starter Kits](readme-starterkits.md)
6262
* [Extending Botkit with Plugins and Middleware](middleware.md)
63+
* [Message Pipeline](readme-pipeline.md)
6364
* [List of current plugins](readme-middlewares.md)
6465
* [Storing Information](storage.md)
6566
* [Logging](logging.md)
6667
* Platforms
6768
* [Web and Apps](readme-web.md)
6869
* [Slack](readme-slack.md)
6970
* [Cisco Spark](readme-ciscospark.md)
71+
* [Microsoft Teams](readme-teams.md)
7072
* [Facebook Messenger](readme-facebook.md)
73+
* [Twilio SMS](readme-twiliosms.md)
7174
* [Twilio IPM](readme-twilioipm.md)
7275
* [Microsoft Bot Framework](readme-botframework.md)
7376
* Contributing to Botkit

‎docs/readme-pipeline.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -401,11 +401,12 @@ controller.middleware.format.use(function(bot, message, platform_message, next)
401401
});
402402
```
403403

404-
## Botkit Documentation Index
404+
## Documentation
405405

406406
* [Get Started](readme.md)
407407
* [Botkit Studio API](readme-studio.md)
408408
* [Function index](readme.md#developing-with-botkit)
409+
* [Starter Kits](readme-starterkits.md)
409410
* [Extending Botkit with Plugins and Middleware](middleware.md)
410411
* [Message Pipeline](readme-pipeline.md)
411412
* [List of current plugins](readme-middlewares.md)

‎docs/readme-slack.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1282,11 +1282,12 @@ var controller = Botkit.slackbot({
12821282
});
12831283
```
12841284

1285-
## Botkit Documentation Index
1285+
## Documentation
12861286

12871287
* [Get Started](readme.md)
12881288
* [Botkit Studio API](readme-studio.md)
12891289
* [Function index](readme.md#developing-with-botkit)
1290+
* [Starter Kits](readme-starterkits.md)
12901291
* [Extending Botkit with Plugins and Middleware](middleware.md)
12911292
* [Message Pipeline](readme-pipeline.md)
12921293
* [List of current plugins](readme-middlewares.md)

‎docs/readme-starterkits.md

Lines changed: 41 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1 +1,42 @@
11
# Botkit Starter Kits
2+
3+
## [Botkit Anywhere](https://github.com/howdyai/botkit-starter-web)
4+
5+
Build a bot for the web and embed it in your site or native application.
6+
7+
## [Slack Starter Kit](https://github.com/howdyai/botkit-starter-slack)
8+
9+
Everything you need to build a Slack application or custom internal integration
10+
11+
## [Microsoft Teams Starter Kit](https://github.com/howdyai/botkit-starter-teams)
12+
13+
Everything you need to build a bot, compose extension or tab for Microsoft Teams
14+
15+
## [Cisco Spark Starter Kit](https://github.com/howdyai/botkit-starter-ciscospark)
16+
17+
Everything you need to build a custom bot for Cisco Spark
18+
19+
## Documentation
20+
21+
* [Get Started](readme.md)
22+
* [Botkit Studio API](readme-studio.md)
23+
* [Function index](readme.md#developing-with-botkit)
24+
* [Starter Kits](readme-starterkits.md)
25+
* [Extending Botkit with Plugins and Middleware](middleware.md)
26+
* [Message Pipeline](readme-pipeline.md)
27+
* [List of current plugins](readme-middlewares.md)
28+
* [Storing Information](storage.md)
29+
* [Logging](logging.md)
30+
* Platforms
31+
* [Web and Apps](readme-web.md)
32+
* [Slack](readme-slack.md)
33+
* [Cisco Spark](readme-ciscospark.md)
34+
* [Microsoft Teams](readme-teams.md)
35+
* [Facebook Messenger](readme-facebook.md)
36+
* [Twilio SMS](readme-twiliosms.md)
37+
* [Twilio IPM](readme-twilioipm.md)
38+
* [Microsoft Bot Framework](readme-botframework.md)
39+
* Contributing to Botkit
40+
* [Contributing to Botkit Core](../CONTRIBUTING.md)
41+
* [Building Middleware/plugins](howto/build_middleware.md)
42+
* [Building platform connectors](howto/build_connector.md)

‎docs/readme-studio.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -376,12 +376,12 @@ controller.studio.beforeThread('search', 'results', function(convo, next) {
376376
});
377377
```
378378

379-
380-
## Botkit Documentation Index
379+
## Documentation
381380

382381
* [Get Started](readme.md)
383382
* [Botkit Studio API](readme-studio.md)
384383
* [Function index](readme.md#developing-with-botkit)
384+
* [Starter Kits](readme-starterkits.md)
385385
* [Extending Botkit with Plugins and Middleware](middleware.md)
386386
* [Message Pipeline](readme-pipeline.md)
387387
* [List of current plugins](readme-middlewares.md)

‎docs/readme-teams.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -989,12 +989,12 @@ Come to ask questions, share your progress, and commune with your peers!
989989
## About Botkit
990990
Botkit is a product of [Howdy](https://howdy.ai) and made in Austin, TX with the help of a worldwide community of botheads.
991991

992-
993-
## Botkit Documentation Index
992+
## Documentation
994993

995994
* [Get Started](readme.md)
996995
* [Botkit Studio API](readme-studio.md)
997996
* [Function index](readme.md#developing-with-botkit)
997+
* [Starter Kits](readme-starterkits.md)
998998
* [Extending Botkit with Plugins and Middleware](middleware.md)
999999
* [Message Pipeline](readme-pipeline.md)
10001000
* [List of current plugins](readme-middlewares.md)

‎docs/readme-twilioipm.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -288,11 +288,12 @@ controller.on('onChannelAdded', function(bot, message){
288288
});
289289
```
290290

291-
## Botkit Documentation Index
291+
## Documentation
292292

293293
* [Get Started](readme.md)
294294
* [Botkit Studio API](readme-studio.md)
295295
* [Function index](readme.md#developing-with-botkit)
296+
* [Starter Kits](readme-starterkits.md)
296297
* [Extending Botkit with Plugins and Middleware](middleware.md)
297298
* [Message Pipeline](readme-pipeline.md)
298299
* [List of current plugins](readme-middlewares.md)

‎docs/readme-twiliosms.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -121,11 +121,12 @@ bot.reply(message, {
121121
122122
For more details on outgoing media attachments and a full list of accepted MIME types, go to [Twilio's docs on media attachment](https://www.twilio.com/docs/api/rest/accepted-mime-types).
123123
124-
## Botkit Documentation Index
124+
## Documentation
125125
126126
* [Get Started](readme.md)
127127
* [Botkit Studio API](readme-studio.md)
128128
* [Function index](readme.md#developing-with-botkit)
129+
* [Starter Kits](readme-starterkits.md)
129130
* [Extending Botkit with Plugins and Middleware](middleware.md)
130131
* [Message Pipeline](readme-pipeline.md)
131132
* [List of current plugins](readme-middlewares.md)

‎docs/readme-web.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -136,12 +136,12 @@ Come to ask questions, share your progress, and commune with your peers!
136136
## About Botkit
137137
Botkit is a product of [Howdy](https://howdy.ai) and made in Austin, TX with the help of a worldwide community of botheads.
138138

139-
140-
## Botkit Documentation Index
139+
## Documentation
141140

142141
* [Get Started](readme.md)
143142
* [Botkit Studio API](readme-studio.md)
144143
* [Function index](readme.md#developing-with-botkit)
144+
* [Starter Kits](readme-starterkits.md)
145145
* [Extending Botkit with Plugins and Middleware](middleware.md)
146146
* [Message Pipeline](readme-pipeline.md)
147147
* [List of current plugins](readme-middlewares.md)

‎docs/readme.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -968,6 +968,7 @@ Our [starter kits](readme-starterkits.md) all include a customizable Express.js
968968
* [Get Started](readme.md)
969969
* [Botkit Studio API](readme-studio.md)
970970
* [Function index](readme.md#developing-with-botkit)
971+
* [Starter Kits](readme-starterkits.md)
971972
* [Extending Botkit with Plugins and Middleware](middleware.md)
972973
* [Message Pipeline](readme-pipeline.md)
973974
* [List of current plugins](readme-middlewares.md)

0 commit comments

Comments
 (0)