Skip to content

Latest commit

 

History

History
45 lines (35 loc) · 2.1 KB

File metadata and controls

45 lines (35 loc) · 2.1 KB

ROSView documentation

English is the default language for user-facing docs. Simplified Chinese translations use the *.zh.md suffix and are linked from the matching English page.

English Simplified Chinese
../README.md ../README.zh.md
EMBEDDING.md EMBEDDING.zh.md
API.md API.zh.md
ARCHITECTURE.md ARCHITECTURE.zh.md

For library consumers (npm)

Document Description
EMBEDDING.md Step-by-step npm integration, prerequisites, bundler notes, troubleshooting.
EMBEDDING.zh.md Simplified Chinese translation of the embedding guide.
API.md Complete public API: RosViewer, providers, types, utilities, extensions.
API.zh.md Simplified Chinese translation of the API reference.

For contributors

Document Description
DEVELOPMENT.md Dev server, lint/test/build, Playwright e2e, fixtures, environment variables.
ARCHITECTURE.md Product requirements and internal architecture.
ARCHITECTURE.zh.md Simplified Chinese translation of the architecture document.

For maintainers

Document Description
RELEASE.md Version bumps, tags, npm publish, GitHub Release automation.

Repository root

Document Description
../README.md Project overview, quick start, embedding examples.
../README.zh.md Simplified Chinese project overview.
../USER_MANUAL.md End-user manual (English).
../USER_MANUAL.zh.md End-user manual (Simplified Chinese).
../CONTRIBUTING.md How to contribute.
../SECURITY.md Security policy.
../CODE_OF_CONDUCT.md Community guidelines.