Improve documentation
Overview
- Document address https://rill-flow.github.io
- Rill Flow based on Docusaurus Organization Project Document
- Documentation project hosted at https://github.com/rill-flow/rill-flow.github.io
- The multilingual translation of documents is hosted on https://crowdin.com/project/rill-flow
- Hosted using Github Pages
- Document illustrations are drawn usingdraw.io
Once the document is updated or translated the document Github project will implement GitHub Action process:
- Synchronize with the
Crowdin
project, get multilingual translations - Build static page with
Docusaurus
- Submit static content to the gh-pages branch and deploy to Github Pages
Edit Document Online
If only small updates are made, you can click the edit this page
link below the document page and go to the corresponding edit page for action.
Edit Document Offline
Project Structure
├── docs //documents
├── src //site pages
└── static //static assets
Local Preview
yarn start
For more information please refer toDocusaurus
Multilingualism
Project is multilingual usingCrowdin. Current multilingual version contains:
- English
Improve translation
Translation and proofreading in [https://crowdin.com/project/rill-flow] (https://crowdin.com/project/rill-flow) projects.
For more information please refer toCrowdin