search

geofmureithi / ubu-block

Blockchain for African countries election monitoring
Apache License 2.0
11 stars 2 forks source link

Project Documentation & Tutorial #5

Open teddywaweru opened 2 years ago

teddywaweru commented 2 years ago

Rust language is a fairly complex tool , & building blockchain applications on native Rust is an even more complex ordeal. To enable other contributors to understand the concepts employed in the project, I suggest development of documentation that will enable new users(who at least understand concepts in Rust & blockchain) to be able to run through & understand the project's overview. Tasks:

geofmureithi commented 2 years ago

I would like to highlight that one doesn't need rust to use this project. The output of the ci process is a binary that even non-technical users. Here are my thoughts: On issue No: 1. The first objective of this repo should be to focus on non-rust/nontechnical users. It should be easy to setup and pull the blockchain. While I understand the need to talk about rust, I think the scope you have indicated is out of this repo and needs to be trimmed massively. On issue No: 2. This already exists as code written in rust. This just needs cargo docs to build docs. On issue No: 3. I am not sure most users of this will be interested in the code base but rather how to pull and interact with the blockchain. I am not trying to be discouraging but this repo has specific goals and we might not get to meet the broad set of goals. For example issue No 1, here are some links that do exactly that:

I would also encourage you to look at the current Roadmap and suggest with that in mind(documentation without code doesn't make sense). Let me know your thoughts.

teddywaweru commented 2 years ago

Great feedback! On Issue 1, what I understand is that the project is meant to be a platform that other users will be interacting with, but I was referencing to other developers who may be interested in this agenda. On issue 2, 👍 the documentation suffices, plus the Roadmap gives the future plans. On issue 3, my comments were intended to serve other developers, & not the expected users. The intention was to have a foundational definition for the project. I'd say that the issue was ahead of the project's phase of life & some beyond scope. Regardless, I was looking to attract developers with a scheme of the projects intention. I'll re-align to contributing against the roadmap. 👍

I still think there's need to document the agenda of the project in some way. The README.md shows what is technically capable currently, but it isn't as descriptive as you have shared above for potential users.