otko/docs/README.md

OTKO Documentation

Index of the project documentation. Start with the quick guide if you just want to build and run a model; read the architecture page if you are changing code.

Document	What it covers
QUICK_GUIDE.md	Task-first walkthrough: cantilever model, modal analysis, report and script export, display units, undo/redo.
architecture.md	MVVM layering, package responsibilities, threading, persistence, and the fixed OpenSeesPy command order.
roadmap.md	Phase-by-phase feature status, from scaffolding through the earthquake-engineering primitives.
adr/	Architecture Decision Records — the "why" behind individual design choices.
screenshots/	Screenshots referenced by the docs and README.

Architecture Decision Records

• ADR-0001 — GiD/OpenSees schema import
• ADR-0002 — Headless / GUI dependency split

Related documentation

• ../README.md — project overview, install, and quick start.
• ../CONTRIBUTING.md — dev setup, layering rules, commit style, and verify commands.
• ../AGENTS.md — condensed context for automated agents.
• gap-analysis-gidopensees.md — gap analysis against the GiD/OpenSees reference.
• ../examples/README.md — the bundled example models.