This folder contains the source code for the Kairo documentation website, built with Docusaurus.
docs/: The actual documentation Markdown files.src/: Custom React pages and global CSS.static/: Static assets (images, etc.).docusaurus.config.js: Site configuration.sidebars.js: Sidebar organization.
- Navigate to the
docs/directory. - Install dependencies:
npm install. - Start the development server:
npm start. - Open
http://localhost:3000in your browser.
The documentation uses PNG images stored in docs/assets/. These are referenced in the Markdown files using the require() syntax for optimal Docusaurus processing.
To update an image:
- Replace the file in
docs/assets/with a new version (keep the same filename). - Or, add a new image to
docs/assets/and update the corresponding Markdown file.
A GitHub Action is already configured in .github/workflows/deploy-docs.yml. It will automatically:
- Build the documentation.
- Deploy it to your GitHub Pages site (typically
https://<username>.github.io/kairo/) whenever you push changes to themainbranch.
If you find errors or want to add new sections, please edit the files in this directory and submit a Pull Request.