Guides

Reference guides for working in this project. Read the relevant guide before starting a task in that area.

Writing TypeScript Code

Formatting rules, naming conventions, design patterns, and architectural principles for all TypeScript in this project. Read this before writing any application code.

Read the guide

Writing Editor Panels

How to create a new panel for the editor: component files, toolbar requirement, connectedCallback initialisation, duplicate support, registration in the tab container menu, and responsive layout rules.

Read the guide

Writing Backend Routes

How to add a new API endpoint to the Express server: router file layout, auth middleware, reading request data, JSON file storage, streaming responses, and mounting in server/index.ts.

Read the guide

Locales

How user-visible strings are stored as files, auto-generated into typed TypeScript constants, and fetched at runtime via LocaleManager. Read this before adding or changing any user-visible text.

Read the guide