Skip to content

Latest commit

 

History

History
 
 

README.md

Architecture Decision Records (ADRs)

This directory contains Architecture Decision Records for the AetherMint project. ADRs document significant architectural decisions, the context in which they were made, the alternatives considered, and the consequences of each decision.

What is an ADR?

An Architecture Decision Record is a document that captures an important architectural decision made along with its context and consequences. ADRs follow the Michael Nygard format.

ADR Index

ADR Title Status Date
001 Choice of Stellar/Soroban over Ethereum/EVM Accepted 2024-06
002 Dual database strategy (PostgreSQL + MongoDB) Accepted 2024-07
003 IPFS for decentralized content storage Accepted 2024-08
004 Federated learning architecture for AI/ML features Accepted 2024-09
005 Quantum-resistant cryptography integration Proposed 2024-10
006 Microservices-lite architecture (monolith with service boundaries) Accepted 2024-06
007 TypeScript adoption strategy (gradual migration from JS) Accepted 2024-06

Statuses

  • Proposed: The decision is under discussion.
  • Accepted: The decision has been agreed upon and is being implemented.
  • Deprecated: The decision has been superseded by a newer ADR.
  • Superseded: A newer ADR has replaced this decision.

Creating a New ADR

  1. Copy template.md to a new file with the next ADR number.
  2. Fill in the sections: Title, Status, Context, Decision, Alternatives Considered, Consequences.
  3. Add the ADR to the index table above.
  4. Submit a pull request for review.

See template.md for the ADR template.