This directory contains detailed documentation for AI coding agents working on the HyperDX codebase. These files use progressive disclosure - they're referenced from AGENTS.md but only read when needed.
Instead of stuffing all instructions into AGENTS.md (which goes into every conversation), we keep detailed, task-specific information here. This ensures:
- Better focus: Only relevant context gets loaded per task
- Improved performance: Smaller context window = better instruction following
- Easier maintenance: Update specific docs without bloating the main file
architecture.md- System architecture, data models, service relationships, security patternstech_stack.md- Technology choices, UI component patterns, library usagedevelopment.md- Development workflows, testing strategy, common tasks, debuggingcode_style.md- Code patterns and best practices. Read before adding a type, Zod schema, helper, or component in any package (grep-first rule, plus a map of what already lives incommon-utils), and before anypackages/appUI change.page_layout.md- PageHeader, PageLayout, and consistent page chrome (titles, actions, tool pages)naming_objects.md- How users name and rename objects (dashboards, saved searches, tiles) withInlineNameInput. Read before adding or changing any place where something gets a name.data_viz_colors.md- Chart, heatmap, and semantic status colors. Read before adding or changing any color in a chart, sparkline, heatmap, legend, or status pill.themes.md- How the brand theme system (HyperDX vs ClickStack) and color mode (light/dark/system) work. Read before changing anything inpackages/app/src/theme/, adding semantic CSS variables, or touching brand-conditional UI.observability.md- Instrumentation standards (tracing, metrics, context) and the shared helpers. Read when adding or changing a feature.evals.md- MCP eval framework: dual-slot setup, running A/B comparisons between branches, interpreting results. Read before running evals or benchmarking MCP changes.
When starting a task:
- Agent reads
AGENTS.mdfirst (always included) - Agent determines which (if any) docs from this directory are relevant
- Agent reads only the needed documentation
- Agent proceeds with focused, relevant context
- Keep files focused on their specific domain
- Use file/line references instead of code snippets when possible
- Update when patterns or architecture change
- Keep documentation current with the codebase