search

vocdoni / docs

Vocdoni documentation
6 stars 8 forks source link

Usage of "dvote" name (and also gateway VS node) #64

Open ed255 opened 3 years ago

ed255 commented 3 years ago

Some of the documents contain diagrams where a piece called "DVote" appears, like this https://docs.vocdoni.io/architecture/component-interaction.html#prior-to-voting

It seems that dvote is a legacy name that was commonly used to identify client libraries interfacing the vocdoni-node. As a newcomer this is confusing because I see a piece called DVote but the text doesn't make any reference to it and I need to figure out what that is.

I also sometimes have trouble distinguishing the definition between vocdoni node and vocdoni gateway. For example, we have the repository vocdoni-node but it contains code to run a gateway. Is a gateway a superset of a node? if so, maybe the repository should be vocdoni-gateway?

ed255 commented 3 years ago

Another example of this usage is here http://localhost:8080/architecture/libraries-tooling.html#go-dvote go-dvote is now called vocdoni-node, the documentation should be updated in that regard.

NateWilliams2 commented 3 years ago

In many contexts, Dvote is used as a separate component from Client (eg. in sequence diagrams describing architecture). This makes sense from a developer perspective (the Client uses the devote library) but not from an architecture perspective (the Client as a component is not separate from the library it uses). @arnaucube @p4u @emmdim @brickpop any strong opinions on whether to keep the Client Library separate from the Client in architecture diagrams?

Example of such a diagram here: https://docs.vocdoni.io/architecture/component-interaction.html#prior-to-voting