Back to Quickwit

Supplement NNN: Title

docs/internals/adr/supplements/000-supplement-template.md

0.9.01.4 KB
Original Source

Supplement NNN: Title

Philosophy: [Optional: A guiding principle for this roadmap/report] Parent ADR: [Link to ADR]

Last Updated: YYYY-MM-DD Status: [e.g. In Progress, Complete, Blocked]


Status Summary

[Optional: High-level metrics or status table]

MetricValueTargetNotes
Pass Rate0%100%...

Roadmap & Progress

Use checkbox tasks (- [ ]) to track progress. Mark completed items with - [x].

Phase 1: [Phase Name] (Status: [e.g. Done])

  • Task Name - [Description]
    • Context: [Link to issue/context]
  • Task Name
    • Sub-task 1
    • Sub-task 2

Phase 2: [Phase Name] (Status: [e.g. In Progress])

  • Task Name
  • Task Name

Detailed Reports / Metrics

[Optional: Detailed tables, gap analysis, or technical notes]

CategoryStatusNotes
.........

Implementation Notes

[Optional: Notes on how to implement, key files, or architecture decisions specific to this roadmap]

Key Files:

  • path/to/file.rs - [Description]

How to Update

  1. Mark Progress: Change - [ ] to - [x] when a task is complete.
  2. Add Context: Add notes or links to PRs/commits for completed items.
  3. Update Metrics: Update the Status Summary table at the top.
  4. Add New Items: Add new tasks to the appropriate phase as they are discovered.