mirror of https://github.com/Comfy-Org/ComfyUI_frontend.git synced 2026-01-26 19:09:52 +00:00

Files

Christian Byrne 687580e155 [docs] Fix ADR numbering and add missing entry to README (#5365 )

- Rename 0004-crdt-based-layout-system.md to 0003-crdt-based-layout-system.md
- Update title from "4. Centralized..." to "3. Centralized..."
- Add ADR 0003 entry to docs/adr/README.md index table

🤖 Generated with [Claude Code](https://claude.ai/code)

Co-authored-by: Claude <noreply@anthropic.com>
Co-authored-by: Alexander Brown <drjkl@comfy.org>

2025-09-05 20:38:05 -07:00

2.3 KiB

Raw Blame History

Architecture Decision Records

This directory contains Architecture Decision Records (ADRs) for the ComfyUI Frontend project.

What is an ADR?

An Architecture Decision Record captures an important architectural decision made along with its context and consequences. ADRs help future developers understand why certain decisions were made and provide a historical record of the project's evolution.

ADR Index

ADR	Title	Status	Date
0001	Merge LiteGraph.js into ComfyUI Frontend	Accepted	2025-08-05
0002	Restructure as a Monorepo	Accepted	2025-08-25
0003	Centralized Layout Management with CRDT	Proposed	2025-08-27

Creating a New ADR

Copy the template below
Name it with the next number in sequence: NNNN-descriptive-title.md
Fill in all sections
Update this index
Submit as part of your PR

ADR Template

# N. Title

Date: YYYY-MM-DD

## Status

[Proposed | Accepted | Rejected | Deprecated | Superseded by [ADR-NNNN](NNNN-title.md)]

## Context

Describe the issue that motivated this decision and any context that influences or constrains the decision.

- What is the problem?
- Why does it need to be solved?
- What forces are at play (technical, business, team)?

## Decision

Describe the decision that was made and the key points that led to it.

- What are we going to do?
- How will we do it?
- What alternatives were considered?

## Consequences

### Positive

- What becomes easier or better?
- What opportunities does this create?

### Negative

- What becomes harder or worse?
- What risks are we accepting?
- What technical debt might we incur?

## Notes

Optional section for additional information, references, or clarifications.

ADR Status Values

Proposed: The decision is being discussed
Accepted: The decision has been agreed upon
Rejected: The decision was not accepted
Deprecated: The decision is no longer relevant
Superseded: The decision has been replaced by another ADR

2.3 KiB Raw Blame History