Skip to content

Commit c1b505e

Browse files
feat: initialize Docusaurus-based documentation project with core concept and feature guides
1 parent 2db1ae7 commit c1b505e

44 files changed

Lines changed: 1348 additions & 0 deletions

Some content is hidden

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

.github/workflows/deploy-docs.yml

Lines changed: 46 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,46 @@
1+
name: Deploy Documentation
2+
3+
on:
4+
push:
5+
branches: [main]
6+
paths:
7+
- 'docs/**'
8+
workflow_dispatch:
9+
10+
permissions:
11+
contents: read
12+
pages: write
13+
id-token: write
14+
15+
jobs:
16+
deploy:
17+
runs-on: ubuntu-latest
18+
steps:
19+
- uses: actions/checkout@v4
20+
with:
21+
fetch-depth: 0
22+
23+
- name: Setup Node
24+
uses: actions/setup-node@v4
25+
with:
26+
node-version: 20
27+
cache: 'npm'
28+
cache-dependency-path: docs/package.json
29+
30+
- name: Install dependencies
31+
run: npm install
32+
working-directory: docs
33+
34+
- name: Build website
35+
run: npm run build
36+
working-directory: docs
37+
38+
- name: Upload artifact
39+
uses: actions/upload-pages-artifact@v3
40+
with:
41+
path: docs/build
42+
43+
- name: Deploy to GitHub Pages
44+
id: deployment
45+
uses: actions/deploy-pages@v4
46+

docs/.gitignore

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
.docusaurus
2+
.cache
3+
.temp
4+
build
5+
node_modules

docs/README.md

Lines changed: 38 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,38 @@
1+
# Kairo Documentation
2+
3+
This folder contains the source code for the Kairo documentation website, built with [Docusaurus](https://docusaurus.io/).
4+
5+
## Structure
6+
7+
- `docs/`: The actual documentation Markdown files.
8+
- `src/`: Custom React pages and global CSS.
9+
- `static/`: Static assets (images, etc.).
10+
- `docusaurus.config.js`: Site configuration.
11+
- `sidebars.js`: Sidebar organization.
12+
13+
## How to use
14+
15+
### Local Development
16+
17+
1. Navigate to the `docs/` directory.
18+
2. Install dependencies: `npm install`.
19+
3. Start the development server: `npm start`.
20+
4. Open `http://localhost:3000` in your browser.
21+
22+
### Visual Assets
23+
24+
The documentation uses PNG images stored in `docs/assets/`. These are referenced in the Markdown files using the `require()` syntax for optimal Docusaurus processing.
25+
26+
To update an image:
27+
1. Replace the file in `docs/assets/` with a new version (keep the same filename).
28+
2. Or, add a new image to `docs/assets/` and update the corresponding Markdown file.
29+
30+
### Deployment
31+
32+
A GitHub Action is already configured in `.github/workflows/deploy-docs.yml`. It will automatically:
33+
1. Build the documentation.
34+
2. Deploy it to your GitHub Pages site (typically `https://<username>.github.io/kairo/`) whenever you push changes to the `main` branch.
35+
36+
## Contributing
37+
38+
If you find errors or want to add new sections, please edit the files in this directory and submit a Pull Request.

docs/assets/ai_assistant.png

161 KB
Loading

docs/assets/cli_api.png

66.4 KB
Loading

docs/assets/config_demo.png

117 KB
Loading

docs/assets/export_menu.png

41.6 KB
Loading

docs/assets/focus_mode.png

41.4 KB
Loading

docs/assets/fuzzy_search.png

66.4 KB
Loading

docs/assets/git_sync.png

67.5 KB
Loading

0 commit comments

Comments
 (0)