Skip to content

Latest commit

 

History

History
165 lines (133 loc) · 7.82 KB

File metadata and controls

165 lines (133 loc) · 7.82 KB
tags
index
developer
aliases
Developer Index

Developer Documentation

Subdirectories

Directory Description
[[audits/_index|audits/]] Code quality and architecture audits
[[i18n/_index|i18n/]] Internationalization and translation docs
[[skills/_index|skills/]] Skills system documentation

Core References

Document Description
CODE_REVIEW_HARDENING Code review hardening guidance
doc-management Documentation management, zones, and tagging
AUTOBOT_REFERENCE IPs, playbooks, quick reference
DEVELOPER_SETUP Developer onboarding
HARDCODING_PREVENTION Rules against hardcoded values

Architecture & Design

Document Description
01-architecture System architecture overview
CODEGEN_MANIFEST Codegen MANIFEST — canonical enum/dataclass → TS generation
02-process-flow Request handling flow
03-api-reference API documentation
04-configuration Configuration options
SSOT_CONFIG_GUIDE Single source of truth config
ROLES Role definitions
TIERED_MODEL_ROUTING LLM tier routing
THINKING_TOOLS_CONFIGURATION Thinking tools setup
VNC_MCP_ARCHITECTURE VNC + MCP architecture
WSL2_NETWORKING WSL2 networking guide

Patterns & Migration Guides

Document Description
ASYNC_MIGRATION_GUIDE Async conversion guide
ASYNC_PATTERNS Async patterns reference
API_RESPONSE_MIGRATION API response standardisation
LAZY_SINGLETON_MIGRATION Lazy singleton pattern
LAZY_SINGLETON_EXAMPLES Lazy singleton examples
LOGGING_MIGRATION_GUIDE Logging standardisation
LOGGING_STANDARDS Logging standards
VALIDATORS_MIGRATION Validator migration
CONFIG_MIGRATION_CHECKLIST Config migration checklist
INITIALIZATION_PATTERN_MIGRATION Init pattern migration
REDIS_CONSOLIDATION_MIGRATION_GUIDE Redis consolidation

Redis

Document Description
REDIS_CLIENT_USAGE Redis client usage guide
REDIS_CONNECTION_POOLING Connection pooling
REDIS_PERFORMANCE_OPTIMIZATION Performance tuning

Code Quality & Standards

Document Description
CODE_QUALITY_ENFORCEMENT Enforcement rules
CODE_QUALITY_IMPLEMENTATION Implementation details
CODE_REUSABILITY_GUIDE Reuse guide
ERROR_CODE_CONVENTIONS Error code standards
ERROR_MONITORING Error monitoring setup
ERROR_HANDLING_MIGRATION_EXAMPLE Error handling examples
ERROR_HANDLING_REFACTORING_PLAN Refactoring plan
UTF8_ENFORCEMENT UTF-8 encoding rules

Agents & AI

Document Description
AGENT_OPTIMIZATION Agent optimisation
AGENT_OPTIMIZATION_SUMMARY Optimisation summary
CLAUDE_API_OPTIMIZATION_SUITE Claude API optimisation
VLLM_PROMPT_OPTIMIZATION_INTEGRATION vLLM prompt optimisation
CHROMADB_INDEXING_OPTIMIZATION ChromaDB indexing

Infrastructure & Deployment

Document Description
INFRASTRUCTURE_DEPLOYMENT Deployment guide
RELEASE_WORKFLOW Release tagging + changelog generation (git-cliff, fragments, release.yml)
SERVICE_MANAGEMENT Service management
ANSIBLE_CREDENTIAL_SECURITY Ansible credential security
OPENVINO_SETUP OpenVINO setup

Observability

Document Description
PROMETHEUS_METRICS_USAGE Prometheus metrics
PROMETHEUS_GITHUB_METRICS GitHub metrics
DISTRIBUTED_TRACING Distributed tracing
BACKEND_DEBUGGING Backend debugging

Testing

Document Description
FRONTEND_TESTING Frontend testing guide (Pinia setup, vue-i18n, mocks)

Authentication & Security

Document Description
AUTHENTICATION_RBAC RBAC and user management (roles, permissions, JWT)

Features (2026-04-14)

New features implemented in the 2026-04-14 development session.

Document Description
HOOKS_SYSTEM_GUIDE Hook system — lifecycle event hooks for agents and workflows
../api/USAGE_METERING_API Usage metering — LLM cost tracking, POST /usage/record, per-user cost queries
PLUGIN_SDK Plugin marketplace — SDK for building and publishing AutoBot plugins
AutoResearch user guide AutoResearch — self-improving experiment loop, prompt optimization, insights
Mobile Responsive UI Chat interface, sidebar, and layout made responsive for mobile viewports (no separate doc — see issues #1804 and #4445)

Refactoring & Analysis

Document Description
ROUTER_REFACTORING Router refactoring
THREAT_DETECTION_REFACTORING Threat detection refactoring
CODE_FINGERPRINTING_REFACTORING Code fingerprinting
CODE_SMELL_REFACTORING_SUMMARY Code smell summary
CONSOLIDATION_PROJECT_STATUS Consolidation status
HTTP_CLIENT_CONSOLIDATION_ASSESSMENT HTTP client consolidation
CHAT_CONVERSATION_CONSOLIDATION_ASSESSMENT Chat consolidation

Knowledge & Memory

Document Description
MEMORY_STORAGE_ROUTINE Memory storage routine
UNIFIED_MEMORY_MANAGER_IMPLEMENTATION Unified memory manager
CHAT_KNOWLEDGE_SERVICE_INTEGRATION Chat-knowledge integration
QUICK_REFERENCE_CHAT_KNOWLEDGE_SERVICE Chat-knowledge quick ref

Miscellaneous

Document Description
MCP_MANAGEMENT_GUIDE MCP management
PLUGIN_SDK Plugin SDK
CLAUDE_MD_OPTIMIZATION_PLAN CLAUDE.md optimisation
APPROVAL_STATUS_DESIGN_IMPROVEMENT Approval status design
INSIGHTS_IMPROVEMENTS Insights improvements
ARCHITECTURE_COMPLIANCE_IMPLEMENTATION_REPORT Compliance report