search

Consensys / verax-documentation

8 stars 6 forks source link

Issues with From a Schema to an Attestation -- Broken build? #8

Open mapachurro opened 2 weeks ago

mapachurro commented 2 weeks ago

Overall, this tutorial does a good job of going step-by-step.

Broken and should be fixed:

The link to the code on github in this line gives you a 404:

image

It looks like something broke there on March 23rd, and maybe never got fixed:

image

Would be nice

When you're walking a user through a "hello world" example like this, where you're giving them one piece of the code at a time, it's good to show them what the whole thing looks like at the end.

In this tutorial, which is an "end to end walkthrough", I would suggest having one "finished script" that is functional and creates / registers a schema, and if it's appropriate / if that's how it works, creating a portal -- and then, a second script showing at the end that shows e.g. "how can I create an attestation, implemented in JS that I can copy paste into my web app UI for users to be able to make an attestation"

mapachurro commented 2 weeks ago

@alainncls, @orbmis :saluting_face:

alainncls commented 2 weeks ago

Hey @mapachurro 👋

I've fixed the link to the Tutorial repository (that we extracted from the main monorepo to a dedicated repo for clarity). Here's the commit and here's the working link.

And thanks for your suggestions! From what I can see, we should do 2 things:

  1. Split the tutorial into 2 tutorials:
    1. a 'frontend' tutorial (basically what we have today)
    2. a 'backend' tutorial to tackle the 'script' scenario
  2. Rework the tutorial a bit, to show the final code

That is 100% doable! 👍