Skip to content

Commit d8110e0

Browse files
morfeusysmorfeusys
committed
vitepress docs
1 parent 60e1131 commit d8110e0

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

69 files changed

+2808
-390
lines changed

‎.github/workflows/build.yml‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ jobs:
1212
- uses: actions/checkout@v2
1313

1414
- name: Cache Gradle
15-
uses: actions/cache@v2
15+
uses: actions/cache@v4
1616
with:
1717
path: |
1818
~/.gradle/caches

‎.github/workflows/deploy.yml‎

Lines changed: 54 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,54 @@
1+
name: Deploy VitePress site to Pages
2+
3+
on:
4+
push:
5+
branches: [master]
6+
workflow_dispatch:
7+
8+
permissions:
9+
contents: read
10+
pages: write
11+
id-token: write
12+
13+
concurrency:
14+
group: pages
15+
cancel-in-progress: false
16+
17+
jobs:
18+
build:
19+
runs-on: ubuntu-latest
20+
steps:
21+
- name: Checkout
22+
uses: actions/checkout@v4
23+
with:
24+
fetch-depth: 0
25+
- name: Setup Node
26+
uses: actions/setup-node@v4
27+
with:
28+
node-version: 22
29+
cache: npm
30+
cache-dependency-path: docs/package-lock.json
31+
- name: Setup Pages
32+
uses: actions/configure-pages@v4
33+
- name: Install dependencies
34+
run: npm ci
35+
working-directory: docs
36+
- name: Build with VitePress
37+
run: npm run docs:build
38+
working-directory: docs
39+
- name: Upload artifact
40+
uses: actions/upload-pages-artifact@v3
41+
with:
42+
path: docs/.vitepress/dist
43+
44+
deploy:
45+
environment:
46+
name: github-pages
47+
url: ${{ steps.deployment.outputs.page_url }}
48+
needs: build
49+
runs-on: ubuntu-latest
50+
name: Deploy
51+
steps:
52+
- name: Deploy to GitHub Pages
53+
id: deployment
54+
uses: actions/deploy-pages@v4

‎docs/.gitignore‎

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
node_modules/
2+
.vitepress/dist/
3+
.vitepress/cache/

‎docs/.vitepress/config.mts‎

Lines changed: 144 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,144 @@
1+
import { defineConfig } from 'vitepress'
2+
3+
export default defineConfig({
4+
title: "JAICF Documentation",
5+
description: "Develop conversational chatbots with JAICF from Just AI",
6+
base: "/",
7+
8+
head: [
9+
['link', { rel: 'icon', href: '/favicon.ico' }],
10+
['meta', { property: 'og:image', content: 'https://help.jaicf.com/assets/images/jaicf-banner.png' }],
11+
['meta', { property: 'og:title', content: 'JAICF Documentation' }],
12+
['meta', { property: 'og:description', content: 'Develop conversational chatbots with JAICF from Just AI' }]
13+
],
14+
15+
themeConfig: {
16+
logo: '/assets/images/header.png',
17+
18+
nav: [
19+
{ text: 'Home', link: '/' },
20+
{ text: 'Quick Start', link: '/pages/Quick-Start' },
21+
{ text: 'GitHub', link: 'https://github.com/just-ai/jaicf-kotlin' }
22+
],
23+
24+
sidebar: [
25+
{
26+
text: 'Getting Started',
27+
items: [
28+
{ text: 'Introduction', link: '/pages/Introduction' },
29+
{ text: 'Installing', link: '/pages/Installing' },
30+
{ text: 'Quick Start', link: '/pages/Quick-Start' },
31+
{ text: 'Quick Start with Dialogflow', link: '/pages/Quick-Start-with-Dialogflow' },
32+
{ text: 'FAQ', link: '/pages/FAQ' }
33+
]
34+
},
35+
{
36+
text: 'Scenario DSL',
37+
collapsed: false,
38+
items: [
39+
{ text: 'Overview', link: '/pages/dsl/index' },
40+
{ text: 'State', link: '/pages/dsl/state' },
41+
{ text: 'Action', link: '/pages/dsl/action' },
42+
{ text: 'Activator', link: '/pages/dsl/activator' },
43+
{
44+
text: 'Activators',
45+
collapsed: true,
46+
items: [
47+
{ text: 'Overview', link: '/pages/dsl/activators/index' },
48+
{ text: 'Intent', link: '/pages/dsl/activators/intent' },
49+
{ text: 'Event', link: '/pages/dsl/activators/event' },
50+
{ text: 'Regex', link: '/pages/dsl/activators/regex' },
51+
{ text: 'Any Intent', link: '/pages/dsl/activators/anyIntent' },
52+
{ text: 'Any Event', link: '/pages/dsl/activators/anyEvent' },
53+
{ text: 'Catch All', link: '/pages/dsl/activators/catchAll' }
54+
]
55+
},
56+
{ text: 'Context', link: '/pages/dsl/context' },
57+
{ text: 'Request', link: '/pages/dsl/request' },
58+
{ text: 'Reactions', link: '/pages/dsl/reactions' },
59+
{ text: 'Fallback', link: '/pages/dsl/fallback' },
60+
{ text: 'Only If', link: '/pages/dsl/onlyIf' },
61+
{ text: 'Append', link: '/pages/dsl/append' }
62+
]
63+
},
64+
{
65+
text: 'Channels',
66+
collapsed: false,
67+
items: [
68+
{ text: 'Overview', link: '/pages/channels/index' },
69+
{ text: 'JAICP', link: '/pages/channels/jaicp' },
70+
{ text: 'Chat Widget', link: '/pages/channels/chat-widget' },
71+
{ text: 'Chat API', link: '/pages/channels/chat-api' },
72+
{ text: 'Telephony', link: '/pages/channels/telephony' },
73+
{ text: 'Aimybox', link: '/pages/channels/aimybox' },
74+
{ text: 'Amazon Alexa', link: '/pages/channels/alexa' },
75+
{ text: 'Google Actions', link: '/pages/channels/google-actions' },
76+
{ text: 'Facebook Messenger', link: '/pages/channels/facebook' },
77+
{ text: 'Slack', link: '/pages/channels/slack' },
78+
{ text: 'Telegram', link: '/pages/channels/telegram' },
79+
{ text: 'Viber', link: '/pages/channels/viber' },
80+
{ text: 'Yandex Alice', link: '/pages/channels/yandex-alice' }
81+
]
82+
},
83+
{
84+
text: 'NLU',
85+
collapsed: false,
86+
items: [
87+
{ text: 'Overview', link: '/pages/nlu/index' },
88+
{ text: 'Caila', link: '/pages/nlu/Caila' },
89+
{ text: 'Dialogflow', link: '/pages/nlu/Dialogflow' },
90+
{ text: 'Amazon Lex', link: '/pages/nlu/Lex' },
91+
{ text: 'Rasa', link: '/pages/nlu/Rasa' }
92+
]
93+
},
94+
{
95+
text: 'Environment',
96+
collapsed: false,
97+
items: [
98+
{ text: 'Overview', link: '/pages/env/index' },
99+
{ text: 'Ktor', link: '/pages/env/Ktor' },
100+
{ text: 'Spring Boot', link: '/pages/env/Spring-Boot' },
101+
{ text: 'AWS Lambda', link: '/pages/env/AWS-Lambda' },
102+
{ text: 'Heroku', link: '/pages/env/Heroku' },
103+
{ text: 'Docker', link: '/pages/env/Docker' },
104+
{ text: 'JAICP Cloud', link: '/pages/env/JAICP-Cloud' },
105+
{ text: 'Android', link: '/pages/env/Android' },
106+
{ text: 'MapDB', link: '/pages/env/MapDB' },
107+
{ text: 'MongoDB', link: '/pages/env/MongoDB' }
108+
]
109+
},
110+
{
111+
text: 'Features',
112+
collapsed: false,
113+
items: [
114+
{ text: 'Overview', link: '/pages/features/index' },
115+
{ text: 'Bot Routing', link: '/pages/features/Bot-Routing' },
116+
{ text: 'BotContext Delegates', link: '/pages/features/BotContext-Delegates' },
117+
{ text: 'Conversation Logging', link: '/pages/features/Conversation-Logging' },
118+
{ text: 'Hooks', link: '/pages/features/Hooks' },
119+
{ text: 'Testing', link: '/pages/features/Testing' }
120+
]
121+
},
122+
{
123+
text: 'Deployment',
124+
items: [
125+
{ text: 'Deployment Guide', link: '/pages/Deployment' }
126+
]
127+
}
128+
],
129+
130+
socialLinks: [
131+
{ icon: 'github', link: 'https://github.com/just-ai/jaicf-kotlin' },
132+
{ icon: 'twitter', link: 'https://twitter.com/JustAIglobal' }
133+
],
134+
135+
footer: {
136+
message: 'Documentation for JAICF - Just AI Conversational Framework',
137+
copyright: 'Copyright © Just AI'
138+
},
139+
140+
search: {
141+
provider: 'local'
142+
}
143+
}
144+
})

‎docs/404.md‎

Lines changed: 2 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,9 @@
11
---
2-
layout: default
3-
nav_exclude: true
2+
title: 404
43
---
54

65
# 404
7-
{: .fs-10 }
86

97
Sorry, but this page was not found
10-
{: .fs-6 .fw-300}
118

12-
[Go to the home page]({{ site.baseurl }}/)
9+
[Go to the home page](/)

‎docs/Gemfile‎

Lines changed: 0 additions & 4 deletions
This file was deleted.

‎docs/Gemfile.lock‎

Lines changed: 0 additions & 74 deletions
This file was deleted.

‎docs/README.md‎

Lines changed: 39 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,41 @@
1-
# JAICF documentation
1+
# JAICF Documentation
22

3-
JAICF documentation uses [Github pages with Jekyll](https://docs.github.com/en/pages/setting-up-a-github-pages-site-with-jekyll) with [Just Docs](https://pmarsceill.github.io/just-the-docs/) template.
3+
JAICF documentation uses [VitePress](https://vitepress.dev/).
44

5-
To start and edit locally please follow [this instructions](https://docs.github.com/en/pages/setting-up-a-github-pages-site-with-jekyll/testing-your-github-pages-site-locally-with-jekyll).
5+
## Prerequisites
6+
7+
- Node.js 18 or higher
8+
9+
## Setup
10+
11+
Install dependencies:
12+
13+
```bash
14+
npm install
15+
```
16+
17+
## Development
18+
19+
Start the development server:
20+
21+
```bash
22+
npm run docs:dev
23+
```
24+
25+
The documentation will be available at http://localhost:5173/
26+
27+
## Build
28+
29+
Build the documentation for production:
30+
31+
```bash
32+
npm run docs:build
33+
```
34+
35+
## Preview Production Build
36+
37+
Preview the production build locally:
38+
39+
```bash
40+
npm run docs:preview
41+
```

0 commit comments

Comments
 (0)