Back to Rolldown

[Feature] — Implementation

internal-docs/template/implementation.md

1.1.21.1 KB
Original Source
<!-- The IMPLEMENTATION doc captures the "how": components, data flow, --> <!-- control flow, file pointers, invariants as realized in code. --> <!-- It pairs with design.md (the "why") — link to it for rationale. --> <!-- When implementing or fixing something described here, link the --> <!-- relevant GitHub issue/PR in commit messages or comments so progress --> <!-- is traceable. -->

[Feature] — Implementation

<!-- If a design.md exists, point to it for the "why". Drop this line --> <!-- for an implementation-only feature with no design.md. -->

The rationale and principles behind this live in design.md.

Summary

One paragraph: a map of the machinery this doc describes.

<!-- Free form. Whatever conveys the implementation: structure, control --> <!-- flow, constraints, examples, a concept-to-file map, etc. -->
  • design.md — the principles and trade-offs behind this
  • ../other-feature/implementation.md - other features that are relevant to this one