Design documents

These documents describe how Raml KQL is designed and why. They are written for contributors and curious readers. For using the app, start with the user guide instead.

The specifications describe the intended design. Where reality turned out differently, the decision log records the change and the reason, and the specification is updated when the change is permanent.

Document	Covers
Architecture	Processes, IPC, security hardening, the stack, data flow
Accounts and authentication	Multi-account, multi-tenant sign-in with MSAL
Discovery, workspaces and aliasing	Discovery, access paths, tenant groups, presentation privacy
Query execution	Fan-out engine, limits, retries, merging, the encrypted cache, the audit log, demo mode
Workbench, editor and IntelliSense	The VS Code look, layout, editor, schema-aware IntelliSense, tabs, history
Results	Grid, group-by, charts, export, deep links
Extensions	The extension model, sandbox, permissions, API, distribution
Query packs	Pack format, parameters, git sources, import
Configuration directory	Config folder, files, merge rules, the settings registry
Privacy and crash reporting	The privacy stance and crash reports
Quality, CI, signing and release	Testing strategy, CI, signing, auto-update
Decision log	Decisions with context and consequences

Proposing a change to the design? Open an issue first. See the contributing guide.