Skip to content
egret-dataPublic

About

Documentation for Egret Platform and Egret Engine

Resources

Stars

0 stars

Watchers

0 watching

Forks

Repository files navigation

Egret documentation

Source of egret-data.github.io/docs: one site with two sections, Platform (platform/) and Engine (engine/). Built with Docusaurus; English is canonical, Vietnamese is a reference translation.

npm ci
npm start        # live preview at http://localhost:3000/docs/
npm run build    # production build; fails on broken links

Layout

Path Content
platform/ Platform docs, organised by purpose: introduction, quick start, deployment, guides, administration, reference, FAQ, known issues
engine/ Engine docs
i18n/vi/ Vietnamese translations (npm run write-translations -- --locale vi)

Contributing

User-visible changes in egret-data/platform or egret-data/engine must ship with a docs PR here. UI changes include refreshed screenshots. Use Conventional Commits.

Licensed under the Apache License 2.0.

About

Documentation for Egret Platform and Egret Engine

Resources

Stars

0 stars

Watchers

0 watching

Forks

Releases

Packages

Contributors

Languages