Skip to content

Implementation Guide Index

Document ID: IMPL-INDEX-001
File Path: docs/19-implementation-guide/index.md
Version: 1.0.0
Status: Active
Owner: Engineering Team
Last Updated: 2026-06-27

1. Purpose

This section is the contributor’s handbook — how to set up a dev environment, build and test, follow coding standards, cut releases, and contribute. It turns the architecture and specs into day-to-day engineering practice.

2. Audience

New and existing contributors to the Wovyr AI Platform monorepo (ADR-0001).

3. Document Map

Document	Responsibility
development-environment.md	Toolchain, prerequisites, local run
build-system.md	Workspace, builds, the Rust SDK
coding-standards.md	Style, error handling, logging, tests
release-process.md	Versioning, releases, signing
contributing.md	Workflow, reviews, security disclosure

4. Quick Start

git clone <repo> && cd wovyr
make setup          # toolchain + hooks
make dev            # run the all-in-one platform locally
make test           # unit + integration

Details in Development Environment and Build System.

5. Principles

Match the surrounding code — consistency over personal preference.
Tests with code — every change ships tests (section 15).
Determinism — no hidden clocks/randomness in core logic.
Security-aware — least privilege, no secrets in code/logs.
Docs follow decisions — update specs/ADRs when design changes.

7. Revision History

Version	Date	Description
1.0.0	2026-06-27	Initial Implementation Guide index