reference

Reference

Information-oriented — Technical descriptions of the machinery and how to operate it.

Reference documentation provides precise, complete, and authoritative information about Open KLara's components. It is designed to be consulted, not read from start to finish.

What belongs here

• API documentation
• Configuration option reference
• Database schema documentation
• Component specifications
• CLI argument reference

Guidelines for writing reference docs

• Be accurate and complete — this is the source of truth
• Use a consistent structure across similar items
• Focus on describing, not explaining or instructing
• Keep it up to date with the codebase
• Use tables and structured formats where appropriate

Planned reference docs

• Dispatcher REST API Reference
• Worker Configuration Reference
• Dispatcher Configuration Reference
• Web Interface Configuration Reference
• Database Schema Reference
• Yara Integration Options