Introduction
Configuration
Commands
init
new
edit
link
list
config
generate
Caveats
Resources
Contributing
License
Project ADRs
1. Record architecture decisions
Date: 2024-03-04
Status
Accepted
Context
We need to record the architectural decisions made on this project.
Decision
We will use Architecture Decision Records, as described by Michael Nygard.
Consequences
See Michael Nygard's article, linked above. For a lightweight ADR toolset, see Nat Pryce's adr-tools.
2. Rewrite it in Rust
Date: 2024-03-04
Status
Accepted
Context
There are a bunch of rewrites already. Some of them look to be incomplete and/or abandoned. This implementation should be at least both feature equivalent to the current tools, compatible (or optionally compatible for backwards, uh, compatibility), and extensible with new features that make the tool even more useful.
Decision
Rewrite the original adr-tools in Rust.
Consequences
A blazingly fast Architectural Decision Record command line tool for the entire world to enjoy.
3. Use mdBook for documentation
Date: 2024-03-06
Status
Accepted
Context
A solid documentation site is the backbone of any good software project. While the tool should have decent built in docs, the doc site can contain a lot more information, as well as general information about the project.
Decision
adrs will have an mdBook based documentation site.
Consequences
Docs will be easier to navigate, search, and keep up to date.