navara-add-docs-example
Installation
SKILL.md
Adding code examples to the Navara docs
First read .claude/skills/navara-usage/SKILL.md (and the reference matching the topic) so the snippet demonstrates correct, idiomatic API usage. The authoritative process docs live in the repo — read them before writing:
docs/AGENTS.md— entry point and key principlesdocs/guide/WRITING_RULES.md— terminology and link rulesdocs/guide/NAVARA_THREE_INSTRUCTIONS.md— update workflow, package→section map, WASM.d.tshandlingdocs/guide/NAVARA_THREE_UPDATE_CHECKLIST.md— scenario checklistsdocs/guide/TRANSLATION_GUIDE.md— when touchingja/
Non-negotiable principles
- The code is the source of truth — match the implementation exactly. Types, parameter names, return values, and defaults in a snippet must match the TypeScript source (verify by reading the actual exports/JSDoc, never guess). Material/WASM types are documented in their normalized shape (plain optional properties via
NormalizeWASMClass), not the raw WASM class withfree()/getters — extract from the getters inweb/wasm/**/*.d.ts. - English first. Root locale is English and is the source of truth;
ja/mirrors the structure. Write/update English, then mirror toja/(technical terms and API names stay in English in every locale). - Examples must be complete and runnable — include imports and required setup (e.g.
await view.init()beforeaddLayer), not fragments that would throw if pasted. - Snippets must respect API invariants — e.g. never show
addPluginafterinit(), never show writes tocamera.raw.fov, showLayer.update()with a full config. See the gotcha list in navara-usage.