Code Monkey home page Code Monkey logo

documentation's Introduction

Website

Please see this documentation at developers.verida.io.

This website is built using Docusaurus 2, a modern static website generator.

Installation

$ yarn

Local Development

$ yarn start

This command starts a local development server and opens up a browser window. Most changes are reflected live without having to restart the server.

Build

$ yarn build

This command generates static content into the build directory and can be served using any static contents hosting service.

Search

Search is implemented using Offline / Local Search for Docusaurus. This is find for our site at the moment but may need to change as it grows. The search is only available from a complete build of the site so to test do this:

$ yarn build
$ yarn serve

Deployment

Deployment is autimatically done via AWS Amplify when changes are merged to the main branch.

documentation's People

Contributors

nick-verida avatar cmcwebcode40 avatar aurelticot avatar mykoleg avatar tahpot avatar dependabot[bot] avatar saadibrahim avatar icetrust0212 avatar pkhien95 avatar wrybwow avatar

Watchers

 avatar cawfree avatar Alex J avatar  avatar

documentation's Issues

Add more information about `openUrl` in SSO

  • Add the openURL in the code snippet in the "how to use the SSO SDK" page
  • Add a note about the limitation of opening a new tab
  • Add a note about the recommendation to use hasSession and a conditional connect() for a smoother authentication

New Account API

Add DID document example

We should have an example DID document that helps explain how the DID registry ties everything together.

This should be somewhere in concepts.

Add plausible analytics

Add this and make sure it gets loaded on every page

<script defer data-domain="developers.verida.io" src="https://plausible.io/js/plausible.js"></script>

Update verida-ts libs

Update

  • @verida/client-ts to 1.1.15
  • @verida/verifiable-credentials to 1.1.6
  • @verida/account-web-vault to 1.1.7

Updates to intro.md

  • Change "Welcome to your Web3 toolkit!" to: “Welcome to the Verida Developer Portal’
  • Add: “Verida is a multi-chain protocol for interoperable database storage and messaging built on decentralized identity.”

For each of the 4 boxes, have explainer text. 1-2 sentences. E.g.

  • Read the documentation
    • Add Subtext “Learn about the core concepts of the Verida protocol, the network and more ”
  • Explore API Documentation
    • Add Subtext “Detailed documentation of the Verida JS library”
  • Interactive Tutorial
    • Add Subtext: “Try the interactive tutorial to get you coding with Verida as quickly as possible.”
  • Demos
    • Add Subtext: “Test our demo applications to interact with the Verida protocol ”
      Reduce icon size

Replace the "Download the Verida Vault (Developer Preview)" section with another "box" section (similar to the 4 box section above). The title for this part should be "Getting Started"

This section should have 3 boxes, from left to right:

Update the linked GitHub repos to these:

  • Verida-JS
  • Account Explorer
  • Markdown Notes
  • Storage Node
  • Vault Examples
  • Vue starter kit

Add the subheading under "Github Repositories" that says: "The Verida protocol is comprised of an ecosystem of open source components"

VCs are demo only

Now the VC implementation is for demonstration purposes only the docs should make that clear.

Final updates to docs to complete

Here's a list of things that need fixing before we can close this project out:

  • The HTML title tag is wrong. It should be getting set from config.title in docusaurus.config.js but is instead is Hello from ${siteConfig.title}
  • The HTML description meta tags are wrong. Currently are <meta name="description" content="Description will go into a meta tag in <head />" data-react-helmet="true"> and <meta property="og:description" content="Description will go into a meta tag in <head />" data-react-helmet="true">. Chris asked for the SEO tags to be done and this is one of the main ones.
  • Search doesn't seem to be working. Note that we are going to need to change the URL this is hosted at so we will need to config for this.
  • Please update the link title in the header that goes to https://verida.io. Currently it is titled "Main" and please change that to "Verida Homepage".
  • There are some Markdown-style links that are not being rendered properly. An example is https://main.d3e62gra73ggnc.amplifyapp.com/docs/client-sdk/data#user-owned-datastore where it looks like this:
    image
    Is there a config setting to change this? Or is there a way to find all the cases where this is happening?

Issues requesting social data

I have the same Twitter account connected to two Verida accounts:

  • did:vda:0x77fA3AD11A82965aB59e643Ac59448c262bD905D (which I connected it to first)
  • did:vda:0xC3527839Cd28212D1b56C29Dc294Ed7966feA828

In the Vault the data shows for both.

When I request did:vda:0xC3527839Cd28212D1b56C29Dc294Ed7966feA828 I get the request in the Vault, consent, but no data shows up.

When I request did:vda:0x77fA3AD11A82965aB59e643Ac59448c262bD905D it works as expected.

Create data sync example in tutorial

It is possible to syncronize data between two databases in different application contexts.

This was previously implemented in the https://github.com/verida/practitioner-emr-web project allowing a user to sync their health records between the Vault and the EMR application.

Here is the code in the EMR web application that generates the Vault message requesting data to be syncronized.

The tutorial needs to add the ability for to generate this type of data sync request, to create a local encrypted database in the tutorial context and sync it with data from the Vault (perhaps the contexts or credentials?).

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.