Documentation as a Chatbot. You know, for chat.
npm install @chatopera/docsbot
npm install -g @chatopera/docsbot
`
Now, docsbot is available in CLI path.
Usage
`
docsbot --baseurl $BASE_URL \
-i $DOCS_HOME \
-f $DOCS_FOLDERS \
-o $FAQ_OUTOUT
`
| Key | Sample | Description |
| --- | --- | --- |
| BASE_URL | https://docs.chatopera.com/products/ | conjunction for the per doc page link |
| DOCS_HOME | ~/chatopera/docs/docfx_project/products | Docs root dir |
| DOCS_FOLDERS | chatbot-platform,cskefu | Child dirs to be parsed in root dir |
| FAQ_OUTPUT_FILE | ./tmp/bot.faq.json | Generated file in Chatopera BOT FAQ Format |
Assume your docs folders are like this, and docs site are at
`
$DOCS_HOME(Root dir)
└───chatbot-platform
|───appendix
|───contract
|───explanations
|───howto-guides
|───references
│ ├───func-builtin
│ └───sdk
│ ├───chatbot
│ └───chatopera
└───tutorials
`
Then, the Docs link address of $DOCS_HOME/chatbot-platform/appendix/index.md would be interpreted as https://docs.chatopera.com/products/chatbot-platform/appendix/index.html.
This docs are also hosted on GitHub.
* baseurl: set with command line
* docfoler: iterater with DOCS_FOLDER, split by ,
* filepath: the markdown files in each docfoler, where extension .md is replaced with .html
Upload into Chatopera BOT Platform
Install Chatopera SDK for bot CLI.
`
npm install -g @chatopera/sdk
`
Touch .env
`
Chatopera BOT Service endpoint
BASE_URL=https://docs.chatopera.com/products/
BOT_PROVIDER=https://bot.chatopera.com
BOT_CLIENT_ID=xx
BOT_CLIENT_SECRET=xx
BOT_ACCESS_TOKEN=
BOT_FAQ_FILE is generated by docsbot
BOT_FAQ_FILE=bot.faq.json
`
Run the job
`
source .env
bot faq -a import -f ./$BOT_FAQ_FILE
`
$3
`
docsbot --help
`
Development
`
npm install
node bin/cmd.js --help
cp sample.env .env
./scripts/dev.sh
``