Skip to content

Repository files navigation

graphene docs

The documentation site of graphene — Docusaurus, docs-only mode (the docs tree IS the site), English + Russian locales, mermaid diagrams enabled.

Development

yarn install
make dev        # live-reload, EN only: http://localhost:3000/docs/
make dev-ru     # live-reload, RU only: http://localhost:3002/docs/ru/
make check      # typecheck + production build — what CI runs
make serve      # BOTH locales, production build, on :3000

A dev server compiles exactly one locale — the other locale's URLs on that port do not exist (the router crashes instead of 404-ing; a Docusaurus quirk). Never run make dev and make dev-ru at the same time: both write the shared .docusaurus dir and corrupt each other. To see both locales at once, use make serve.

Pages live under docs/: a folder is a sidebar category, a file is a page (the sidebar is autogenerated). Mermaid works in fenced ```mermaid blocks.

Deployment

Every push to main builds and deploys to GitHub Pages (https://graphene-ci.github.io/docs/) via .github/workflows/ci.yml; pull requests run the same typecheck + build without deploying.

About

Docs for Gaphene-CI

Resources

Contributing

Stars

1 star

Watchers

0 watching

Forks

Releases

Packages

Contributors

Languages