cuframes-docs

Source for https://cuframes.dev — documentation for the cuframes library.

Built with Docusaurus 3 by the dagstack docs convention.

Local development

cd site
npm install
npm start         # http://localhost:3000

Build (static output)

cd site
npm run build     # → site/build/
npm run serve     # preview localhost

i18n

EN is the source of truth, RU is a translation in site/i18n/ru/.

To regenerate RU stubs after adding new EN pages:

cd site
npm run write-translations -- --locale ru

Translate the new files manually (no MT integration yet).

Structure

site/
├── docs/                   # EN content
│   ├── intro.mdx           # landing
│   ├── getting-started/
│   ├── concepts/
│   ├── integration/
│   ├── reference/
│   └── faq.md
├── i18n/ru/                # RU translations (parallel structure)
├── docusaurus.config.ts
├── sidebars.ts
└── src/css/custom.css

Sidebars are autogenerated from directory structure. Order via _category_.json + frontmatter sidebar_position.

License

This documentation repo: Apache-2.0 (same as other *-docs repos in the org).
cuframes library itself: LGPL-2.1+.

1.3 KiB Raw Permalink Blame History