Code Monkey home page Code Monkey logo

docs's Introduction

Vocdoni Documentation

This documentation of the Vocdoni Open Stack is build with the VuePress framework. All of the content in this repository can be viewed on the Documentation page.

Development

  • npm install
  • npm run dev for hot-refresh mode OR
  • npm build for static build, then host on an http(s) server

docs's People

Contributors

akv0 avatar arnaucube avatar brickpop avatar d3vnil avatar dependabot[bot] avatar divdevdoe avatar ed255 avatar ferranrego avatar imw avatar jordipainan avatar marcvelmer avatar natewilliams2 avatar p4u avatar randomshinichi avatar rbaig avatar selankon avatar vdo avatar wissenistnacht avatar xavivives avatar zepcp avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar  avatar

docs's Issues

How to use Inter-blockchain communication with Ethereum?

The docs suggest that a Tendermint-based Vochain and Ethereum mainnet can use IBC to communicate:

We can also use interchain communication in order to pass messages between blockchains and trigger certain actions.

However, this is a non-trivial task โ€“ if at all possible โ€“ for blockchains with probabilistic finality like Ethereum 1.x. https://cosmos.network/intro#probabilistic-finality-chains described how this can work for moving tokens around using escrow contracts. The given example implies a messaging delay of 20 minutes and has a very limited use case.

If this is still the way to go, I think we need to document more about how this communication could potentially look like.

The "Last Update" note in each page has an unexpected date

At the end of each rendered page there's a note like this:

Last Updated: 8/5/2021, 8:36:13 AM

I was expecting this value to be the last time that particular page was updated, but that's not the case; as I'm seeing pages that haven't been updated in the previous week, yet the "Last Update" for those pages is today.

Maybe what's currently showing is the last time the entire docs was built? If that's the case, I think showing this value in each page can be confusing.

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

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?

Mention of (pk.X, pk.Y) in zk-census-proof.md

In https://github.com/vocdoni/docs/blob/master/src/architecture/protocol/anonymous-voting/zk-census-proof.md
The current proposal doesn't use an elliptic curve for public key, but there are mentions of pk.X and pk.Y:

the public key of the private key is inside a Hash, which is inside the Merkle Tree with the CensusRoot (key=Poseidon(pk.X, pk.Y), value=0)

https://raw.githubusercontent.com/vocdoni/docs/master/src/architecture/protocol/anonymous-voting/zk-census-proof-poseidon-merkletree-diagram.png

Usage of word "claim" for entry in the census

The documentation uses the word "claim" to refer to an entry in the census. This is used in the census service documentation and other parts where the census is mentioned. The meaning of the word "claim" is not defined in the documentation, and it's not clear to me what it means. Who is claiming something? Maybe this comes from the iden3 codebase where an identity is defined as a merkle tree of claims made by the identity?

In any case, I think it would be much clear to use a different name like: "entry" in the census.

document step-by-step/serial voting

the serial process flag is not explained in-depth. It should be described for users & integrators.

One main question (pointed out by @brickpop) is whether all process types are compatible with serial processes, or just multi-question. This should be defined.

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.