This directory contains the design and operating documentation for norte.
- Project specification: product goals, system design, milestones, and constraints.
- Architecture overview: a concise map of the workspace and its dependency rules.
- Theme configuration: bundled themes and custom theme files.
- Keymaps: the seven keymap presets and how to choose one.
- Plugin author guide: writing, building, installing and diagnosing a WASM plugin.
- Architecture decisions: the ADR index and decision history.
- Contributing guide: development workflow and review expectations.
- Security policy: private vulnerability reporting and trust boundaries.
schema/contains the JSON Schemas for application and keymap configuration.policy-example.tomlis a commented policy configuration example.
- Write public documentation in English.
- Prefer short, concrete sentences and descriptive headings.
- Use repository-relative links so documentation works both on GitHub and locally.
- Wrap prose at roughly 80 characters where practical. Do not reflow code, tables, URLs, or generated schemas solely to meet that width.
- Record durable architectural decisions as ADRs; keep implementation steps in plans rather than user-facing guides.