IntersectMBO / cardano-node

The core component that is used to participate in a Cardano decentralised blockchain.
https://cardano.org
Apache License 2.0
3.06k stars 720 forks source link

💳 Technical Debt | End user documentation Audit / Restructure #4330

Open CarlosLopezDeLara opened 2 years ago

CarlosLopezDeLara commented 2 years ago

What

End user documentation is a scattered. Centralize and Improve end user documentation.

Why

Better documentation reduces friction. Users should be able to find clear examples for what they are trying to achieve.

Documentation has been a weakness for long time. Keeping it under the node repo makes it harder to update since every PR must follow the same Reviews, Approvals and CI checks as code.

ltouro commented 2 years ago

Regarding Plutus documentation, some work was outlined here: https://github.com/input-output-hk/plutus/issues/4476#issuecomment-1213185470 which might be useful to keep track of.