Skip to content

Engineering

This section is for people developing, testing, or operating GraphForge. You do not need it to complete a research project. For a first mixed-methods exercise, start with Your first research project.

Engineering follows public behavior through design, pre-release evidence, continuous delivery, and production learning.

flowchart LR
Issue["Bounded issue"] --> Arch["ARCHITECTURE.md"]
Arch --> Test["TESTING.md"]
Test --> Pub["PUBLISHING.md"]
Pub --> Obs["OBSERVABILITY.md"]
Obs -. "validated feedback" .-> Issue
Document Responsibility
ARCHITECTURE.md Problem model, responsibility boundaries, and components that satisfy requirements
TESTING.md How tests and CI prove the system before release
PUBLISHING.md How verified artifacts are versioned, promoted, and rolled back
OBSERVABILITY.md How CI/release/user signals feed discovery
adrs/ ADR index (bodies in ../adr/)

The integrated product and architecture requirements define intended outcomes for M11: Core Analyst UX for v0.6.0. They are requirements for implementation, not claims of shipped functionality.

Document Description
../book/architecture/ Deep architecture notes, pipeline, storage, embedding contracts
../development/ Contributor workflow, testing detail, release process
../contracts/ Frozen public API / fingerprint JSON contracts
../reference/ Compatibility, TCK, scale limits, column naming
Root AGENTS.md Agent workflow and validation gates

Create the next Architecture Decision Record with:

Terminal window
docslime add adr <short-slug>

Until bodies live under engineering/adrs/, add new ADR markdown under docs/adr/ and update both ../adr/README.md and adrs/README.md in the same change. Do not fork a second numbering sequence.