Design Documents

This directory stores active design information for Buffalo Wings. It is organized by document purpose so architecture guidance, planning, and cross-cutting standards do not accumulate in one flat list.

Where To Look

• Start with planning/index.md when you want to know what remains to be built, what horizon a feature belongs to, or what the next roadmap-aligned slice should be.

• Start with architecture/index.md when you want the active subsystem design or the current intended shape of a public interface.

• Start with foundations/index.md when you want standing engineering rules, shared conventions, or cross-project technical boundaries.

• Start with ../research/index.md when you want external references, comparative notes, or future inspiration that is not itself active Wings architecture.

• Start with ../development/checklists/index.md when you want actionable completion tracking such as definitions of done, integration checklists, or release-readiness checklists.

• Start with ../archive/design/ when you need superseded history or migration context rather than the active source-of-truth design.

Placement Rules

• Put future-facing sequencing, prioritization, and milestone planning in planning/.

• Put active subsystem architecture and interface-shape documents in architecture/.

• Put long-lived engineering standards and cross-cutting conventions in foundations/.

• Put external references, inspiration notes, and capability inventories in ../research/.

• Put task tracking, readiness checklists, and “what must be finished before X is complete” documents in ../development/checklists/ rather than in design/.

• Move superseded plans, completed refactor plans, and historical notes into ../archive/design/.

Current Entry Points

• planning/plan.md: short top-level project planning and the starting point for choosing the next slice of work.

• planning/active_work.md: what to focus on next once a workstream needs more breakdown.

• architecture/wing_design.md: active wing design and acceptance criteria.

• architecture/section_curve_interface.md: active open-curve and camber-curve design.

• ../research/codeeli_capabilities_reference.md: external capability inventory for future inspiration.

• foundations/python_package_layout.md: canonical package-structure guidance.

• foundations/numeric_typing.md: project-wide numeric typing rules.

Maintenance Expectation

When adding a new design-oriented document, choose its home based on the rules above and add it to the closest local index or README in the same change.