Run documentation. Tutorial. Examples

ForkbombEu / ncr

no‧code‧room: No code REST API server based on zencode natural language smart contracts

4 stars 2 forks source link

Run documentation. Tutorial. Examples #291

Open puria opened 1 month ago

puria commented 1 month ago

Provide some docs to allow people to adopt more easily ncr

[ ] Tutorial of a service
[ ] Document well the metadata options. Maybe also separated by subjects
[ ] A set of nice and running examples
[ ] Refresh the --help of the CLI

matteo-cristino commented 1 month ago

Isn't this stuff already in the README.md? 🤔

puria commented 1 month ago

Nope ;( Let's start one by one... I do not recall a tutorial, something is needed step by step that explains how to start using ncr and explains also the concepts with a simple usecase.

Something like this:

https://medium.com/think-do-tank/make-with-zencode-and-javascript-aka-easy-crypto-and-human-readable-smart-contracts-in-js-14067d91e8f1

To me we can use for instance this contracts: https://github.com/ForkbombEu/tf-pqcrypto-scripts/tree/main/contracts

matteo-cristino commented 1 month ago

do you want to improve the README or should we create some external documentation? For example using again vitepress