8c3c43709da4db8eee2aa2d012d2b5c593a6ca2a
Initial documentation site for cuframes:
- Landing page (src/pages/index.mdx) — hero, quick example (publisher +
subscriber), comparison table vs naive/DeepStream, honest "early but
production-tested" status
- /docs/intro — full overview
- /docs/getting-started/{install,first-publisher,first-subscriber}
- /docs/concepts/{frame-vs-packet-ring,ownership-modes,sync-vmm-stream}
with mermaid diagrams
- /docs/integration/{ffmpeg-demuxer,ffmpeg-filter,python}
- /docs/reference/{api-c,api-cpp,protocol} — full v4 wire protocol spec
incl. VMM_FDS message, magic 0xCC7C1DCE bump diff
- /docs/faq — comparison vs DeepStream/GStreamer, license, multi-host
limitations
- i18n/ru/ — parallel RU translation (tech terms latin, склонение апостроф)
Build:
- Docusaurus 3.10.1 + theme-mermaid + search-local
- Follows dagstack-* docs convention (canonical: dagstack-plugin-system-docs)
- Apache-2.0 license; cuframes lib itself remains LGPL-2.1+
Co-Authored-By: Claude Opus 4.7 <noreply@anthropic.com>
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+.
Description
Documentation site for cuframes — zero-copy decoded video frames over CUDA, shared across processes. Docusaurus 3, EN/RU, hosted at cuframes.dev.
Languages
MDX
70.2%
TypeScript
24.1%
CSS
5.7%