fix(docs): update ADR docs for structure, standards, clarity, completeness

elesto-dao / elesto

The ElestoDAO node

Apache License 2.0

4 stars 1 forks source link

fix(docs): update ADR docs for structure, standards, clarity, completeness #243

Closed barriebyron closed 1 year ago

barriebyron commented 1 year ago

This PR organizes and improves our ADR documentation:

add TOC to the README as specified in the PROCESS doc
apply style and standards
I want to remove duplicate document since we have 2 DID ADR docs, is the correct DID doc the 002 or the 003?
fix typos and so on

A little editorial and developmental editing love for our most important architectural decision docs.

barriebyron commented 1 year ago

looking for input on which ADR for DID is the canonical true ADR doc, see my question on Discord @noandrea and who else can weigh in? @SenorMonito perhaps? (I would love a PRP list... who is our primary responsible party for the product components?)

barriebyron commented 1 year ago

thank you @spoo-bar for your feedback! Who else can weigh in on these changes? I'd like to see these quality-focused updates go live. @noandrea can you peek?

github-actions[bot] commented 1 year ago

This PR was marked as stale because there was no activity for 10 days

github-actions[bot] commented 1 year ago

This PR was closed because there was no activity for 15 days