andreicscs-HoneyWire/Docs/development/README.md

HoneyWire Development Documentation

This directory contains the technical documentation required for developing, testing, and contributing to the HoneyWire platform.

Getting Started

To initialize a local development environment, proceed to the Local Environment Setup guide.

---

Documentation Index

This directory is strictly organized by functional purpose:

• setup.md: Instructions for configuring local Hub, UI, and Wizard execution environments.
• structure.md: A static map of the monorepo. Identifies component locations.
• workflows.md: Step-by-step action guides for common development tasks (e.g., adding API routes).
• sensors.md: Technical requirements for building decoy containers and integrating Language SDKs.
• wizard.md: Guide for extending the Wizard (CLI commands, heuristic rules, scanner logic).
• contribution-rules.md: Governance, coding standards, and Pull Request requirements.
• maintainer-workflow.md: Internal use only. Advanced CI/CD and registry workflows.

---

Recommended Onboarding Path

1. Setup: Configure your local environment.
2. Structure: Familiarize yourself with the repository layout.
3. Contribution Rules: Review the strict project standards.
4. Workflows or Sensors: Proceed to your specific area of interest.