This directory is the English documentation set for OpenVINO Nim API. The repository keeps the API and implementation vocabulary in English so that code, diagnostics and links remain searchable; the Chinese README provides a bilingual entry point.
| Question | Document |
|---|---|
| I am new to the project | Getting started |
| I need the public types and functions | API overview |
| I need the generated symbol pages | API index after nimble docs |
| I need to know what really works | Compatibility |
| I need to diagnose a loader or runtime failure | Troubleshooting |
| I need the C binding boundary | C API coverage |
| I am planning a feature | Roadmap |
| I need ownership details | Ownership |
| I am migrating from the prototype | Migration guide |
From the repository root:
nimble docsThe task generates a page for every public managed module, the explicit raw
entry point, and a merged symbol index under build/docs. The output is an
artifact in CI and can also be opened locally at build/docs/index.html.
The manual docs-pages workflow builds the same output and deploys it to
GitHub Pages. A maintainer must first enable Pages for GitHub Actions and allow
the github-pages environment; until then, the normal CI artifact remains the
supported hosted copy. The workflow is deliberately manual so an unopened
Pages setting cannot break the required test workflow.
Markdown is checked by nimble lint. New documents need one H1 heading,
language-tagged fenced blocks, descriptive links and a final newline.
Documentation distinguishes three states: implemented and tested, available in the raw layer but not wrapped by the managed API, and planned. Device discovery or a successful compile is never treated as proof of inference support on a device that has not been tested.