Skip to content

Latest commit

 

History

History
47 lines (30 loc) · 1.53 KB

File metadata and controls

47 lines (30 loc) · 1.53 KB

Documentation

Use this directory by task. Most work should need one or two pages, not the whole documentation set.

I Want To Use An App

Start with apps.md.

It explains how apps are launched, what each app is for, expected inputs, and typical outputs.

I Want To Create Or Modify An App

Read apps.md, then ui.md when the work touches layout, controls, previews, callbacks, or debug traces.

Use labkit_ProjectGovernance_app to create a starter app scaffold. After generation, the result is ordinary MATLAB code under apps/<family>/<slug>/.

I Want To Understand The Codebase

Read architecture.md.

It explains the app-first model, when code belongs in an app-owned package, and when a helper is reusable enough for +labkit.

I Need To Validate A Change

Read testing.md.

It explains build tasks, targeted selectors, test layout, fixture expectations, and what automated GUI checks do and do not prove.

I Am Using A Reusable Facade

Facade Read
GUI app shell, specs, view helpers, tools, diagnostics ui.md
Gamry DTA loading, sessions, parser outputs, pulse detection dta.md
Wearable/physiological recordings, ECG peaks, segments, measurements biosignal.md

What Is Not Here

Agent execution rules live in AGENTS.md, scoped AGENTS.md files, and .agents/skills/. Active migration debt lives in .agents/migration_guide.md. Those files are intentionally separate from these human-facing docs.