Bootstrap Architectural Design Records (ADR) in our documentation

[koslambrou]

Added a new section in our readthedocs.

Ultimately, this should be place where we document, propose and comment any architectural and design decisions in plutus-apps.

See: https://plutus-apps--512.org.readthedocs.build/en/512/

Pre-submit checklist:

• Branch
  • Tests are provided (if possible)
  • Commit sequence broadly makes sense
  • Key commits have useful messages
  • Formatting, PNG optimization, etc. are updated
• PR
  • Self-reviewed the diff
  • Useful pull request description
  • Reviewer requested

[andreabedini]

Is the intention that while working on a feture a developer captures decisions in the doc/adr folder which are then discussed during PR?

[joseph-fajen]

I've left a number of comments for us to talk about. Interesting stuff!

[koslambrou]

Is the intention that while working on a feture a developer captures decisions in the doc/adr folder which are then discussed during PR?

@andreabedini Very good question, and we need to discuss this. I see multiple options.

• the person working on a feature has to make a significant design change, then he/she should open an ADR and document the decision
• the person writes an ADR and waits for approval, then he can make the PR with the feature which references the ADR.
• the decision can also be documented after the feature has be merged

[michaelpj]

Nice!