Welcome to the Kaia documentation repository! This repo contains the source files for the official Kaia documentation available at https://docs.kaia.io.
We welcome contributions to help us improve and expand the Kaia documentation. There are a few ways you can contribute:
Whether fixing a typo, suggesting an improvement, or adding new content, your help is valuable.
- Minor fixes (typos, broken links) can be submitted directly via Pull Request by anyone.
- For other changes, the standard process involves submitting an Issue first.
- Internal maintainers and recognized regular contributors may have an expedited workflow for all types of changes.
Please see our detailed Contributing Guide for the full workflows, issue labeling, and guidelines applicable to all contributors.
Kaia docs is available in the following languages:
- English
- 한국어
- 日本語
- 简体中文
- 繁體中文
- Tiếng Việt
If you are fluent in another language and want to contribute translations or improve existing ones:
- Use Crowdin: All translation contributions are managed via the Kaia-Docs Crowdin project.
- Read the Guide: Please refer to the detailed Internationalization page on our documentation site for step-by-step instructions on how to join, translate, and understand the process (including Machine Translation usage and review).
- Use GitHub issues with the
content-translationlabel only for requesting new languages or reporting major, systemic translation problems. Do not use issues for suggesting individual string changes.
Important
Do not submit Pull Requests directly modifying translation files in the i18n directory.
This website is built using Docusaurus v3.
$ npm i
$ npm start
This command starts a local development server and opens up a browser window. Most changes are reflected live without having to restart the server.
$ npm run build
This command generates static content into the build directory and can be served using any static contents hosting service.
Using SSH:
$ USE_SSH=true npm run deploy
Not using SSH:
$ GIT_USER=<Your GitHub username> npm run deploy
If you are using GitHub pages for hosting, this command is a convenient way to build the website and push to the gh-pages branch.