chore(docs): New file names and introduction for some chapters.
This commit is contained in:
parent
ccec3d9645
commit
1dc5639fd5
11 changed files with 82 additions and 30 deletions
|
@ -1,10 +1,26 @@
|
||||||
# General Bots Book
|
# General Bots - The Bot Server
|
||||||
|
|
||||||
## Package Quick Reference
|
Welcome to the General Bots Book. This is a reference material that can be used
|
||||||
|
to understand how the bot server is organized in a form of packages itself and
|
||||||
|
this arrangement can be used to all custom deployed packages like .gbkb, .gbtheme
|
||||||
|
or .gbapp.
|
||||||
|
This book is organized in ten chapters that can be accessed throuhg this table bellow:
|
||||||
|
|
||||||
|Whatsapp|Web|Core|KB|
|
* [Acknowledgments](acknowledgments.md)
|
||||||
|----|-----|----|----|
|
* [Chapter 01 - The Bot Server ](chapter-01-index.md)
|
||||||
|[whatsapp.gblib](https://github.com/pragmatismo-io/BotServer/tree/master/packages/whatsapp.gblib)|[default.gbui](https://github.com/pragmatismo-io/BotServer/tree/master/packages/default.gbui)|[core.gbapp](https://github.com/pragmatismo-io/BotServer/tree/master/packages/core.gbapp)|[kb.gbapp](https://github.com/pragmatismo-io/BotServer/tree/master/packages/kb.gbapp)|
|
* [Chapter 02 - About Packages](chapter-02-about-packages.md)
|
||||||
|
* [Chapter 03 - gbkb Reference](chapter-03-gbkb-reference.md)
|
||||||
|
* [Chapter 04 - gbtheme Reference](chapter-04-gbtheme-reference.md)
|
||||||
|
* [Chapter 05 - gbdialog Reference](chapter-05-gbdialog-reference.md)
|
||||||
|
* [Chapter 06 - gbapp Reference](chapter-06-gbappreference.md)
|
||||||
|
* [Chapter 07 - Administration](chapter-07-administration.md)
|
||||||
|
* [Chapter 08 - Tooling](chapter-08-tooling.md)
|
||||||
|
* [Chapter 09 - Services](chapter-09-services.md)
|
||||||
|
* [Chapter 10 - Contributing](chapter-10-contributing.md)
|
||||||
|
* [Copyright](copyright.md)
|
||||||
|
* [Foreward](foreward.md)
|
||||||
|
* [Glossary](glossary.md)
|
||||||
|
* [Preface](preface.md)
|
||||||
|
|
||||||
### The bot development stack
|
### The bot development stack
|
||||||
|
|
||||||
|
@ -39,24 +55,14 @@ Notes:
|
||||||
|
|
||||||
1. [Download](https://codeload.github.com/pragmatismo-io/BotServer/zip/master) the Zip file.
|
1. [Download](https://codeload.github.com/pragmatismo-io/BotServer/zip/master) the Zip file.
|
||||||
|
|
||||||
|
## NLP
|
||||||
|
|
||||||
## Trainning Topics
|
## Spell Checker
|
||||||
|
|
||||||
* Clone BotServer, BotLib repository
|
## Speech to Text
|
||||||
* Keyboard centric
|
|
||||||
* WIN: micro.exe
|
## Omnichannel
|
||||||
* Launcher
|
|
||||||
* dir/ls/ll, cd, mkdir, move
|
## Branding
|
||||||
* Npm run build
|
|
||||||
* npm update -g
|
## Bot Factory
|
||||||
* node -v
|
|
||||||
* SHIFT+PAGE DOWN/UP on Terminal Window
|
|
||||||
* ncu -a Update all packages in package.json
|
|
||||||
* npm update -g All NPM package on the system
|
|
||||||
* Introduction to General Bo
|
|
||||||
* Environment setup and get the server runni
|
|
||||||
* KB loading
|
|
||||||
* NLP and toolin
|
|
||||||
* Find a NPM package to create a .gbapp that asks for data and output the result
|
|
||||||
* Visual Studio Code Insiders and plugins
|
|
||||||
* Run Build Task tsc:watch
|
|
|
@ -1,4 +1,11 @@
|
||||||
# General Bots Packages Reference
|
# About Packages
|
||||||
|
|
||||||
|
Packages can be stored as folders in the file system, synced with cloud storages and
|
||||||
|
content management systems like SharePoint and even sent like .zip files on a e-mail.
|
||||||
|
Just to increse bot knowledge, intelligence and how they look to us. So working on a
|
||||||
|
General Bots project is like to split the work on several packages if needed and work
|
||||||
|
on a package at once or even share the work with collegues, agencies or development
|
||||||
|
companies to more advanced package building.
|
||||||
|
|
||||||
## How To
|
## How To
|
||||||
|
|
||||||
|
@ -67,3 +74,9 @@ A set of subjects that bot knows in a form of hierarchical menu-based QnA. [A sa
|
||||||
### .gblib
|
### .gblib
|
||||||
|
|
||||||
Shared code that can be used across bot apps.
|
Shared code that can be used across bot apps.
|
||||||
|
|
||||||
|
## System Package Quick Reference
|
||||||
|
|
||||||
|
|Whatsapp|Web|Core|KB|
|
||||||
|
|----|-----|----|----|
|
||||||
|
|[whatsapp.gblib](https://github.com/pragmatismo-io/BotServer/tree/master/packages/whatsapp.gblib)|[default.gbui](https://github.com/pragmatismo-io/BotServer/tree/master/packages/default.gbui)|[core.gbapp](https://github.com/pragmatismo-io/BotServer/tree/master/packages/core.gbapp)|[kb.gbapp](https://github.com/pragmatismo-io/BotServer/tree/master/packages/kb.gbapp)|
|
|
@ -8,6 +8,13 @@ like a TypeScript application. This conversational application will contain
|
||||||
the source code for custom dialogs and behaviour for any .gbot that associate
|
the source code for custom dialogs and behaviour for any .gbot that associate
|
||||||
this deployed .gbapp.
|
this deployed .gbapp.
|
||||||
|
|
||||||
|
A good way to start a .gbapp is to find a NPM package to create a .gbapp that
|
||||||
|
asks for data and output the result. For example, a temperature package can
|
||||||
|
be installed via `npm install temperature` and then have its methods
|
||||||
|
convertToKelvin or convertToCelsius called when user asks for conversion. A
|
||||||
|
.gbapp can persist and read data from database according to the conversation
|
||||||
|
session.
|
||||||
|
|
||||||
## Preparing Environment
|
## Preparing Environment
|
||||||
|
|
||||||
### Windows
|
### Windows
|
||||||
|
@ -138,3 +145,11 @@ static getDialogs(bot: BotAdapter, min: GBMinInstance) {
|
||||||
| mikestead.dotenv | Description here |
|
| mikestead.dotenv | Description here |
|
||||||
| sirtori.indenticator | Description here |
|
| sirtori.indenticator | Description here |
|
||||||
| tandy.color-basic | Description here |
|
| tandy.color-basic | Description here |
|
||||||
|
|
||||||
|
## Common tasks
|
||||||
|
|
||||||
|
| Task | Description |
|
||||||
|
|---------------|-------------------------------------|
|
||||||
|
| npm update -g | Updates NPM |
|
||||||
|
| node -v | Checks node version |
|
||||||
|
| ncu -a | Update all packages in package.json |
|
|
@ -23,3 +23,7 @@ Discontinued commands:
|
||||||
### Move to production (Azure)
|
### Move to production (Azure)
|
||||||
|
|
||||||
* Update bot endpoint;
|
* Update bot endpoint;
|
||||||
|
|
||||||
|
## Bot Analytics
|
||||||
|
|
||||||
|
## Cloud Internals
|
|
@ -1,5 +0,0 @@
|
||||||
|
|
||||||
|
|
||||||
## Quality Assurance
|
|
||||||
|
|
||||||
https://codecept.io/nightmare
|
|
19
book/chapter-08-tooling.md
Normal file
19
book/chapter-08-tooling.md
Normal file
|
@ -0,0 +1,19 @@
|
||||||
|
# General Bots Tooling
|
||||||
|
|
||||||
|
## NLP
|
||||||
|
|
||||||
|
### luis.ai
|
||||||
|
|
||||||
|
## Spell Checker
|
||||||
|
|
||||||
|
### Bing Spell Checker
|
||||||
|
|
||||||
|
## Speech to Text
|
||||||
|
|
||||||
|
### Azure Speech Services
|
||||||
|
|
||||||
|
## Quality Assurance
|
||||||
|
|
||||||
|
### Nightmare
|
||||||
|
|
||||||
|
https://codecept.io/nightmare
|
Loading…
Add table
Reference in a new issue