docs.veres.one's Introduction

Veres One Documentation

Documentation for the Veres One Project.

Tool Installation

This site uses MkDocs and Material for MkDocs.

It is highly recommended to setup a Python virtual environment to install the doc tools. You can install globally also.

In your development environment, install the tools:

$ pip install -r requirements.txt

Development

Site source files are in the docs directory.

Verify your changes with the MkDocs development server:

$ mkdocs serve

Deploy

To build and deploy to the gh-pages branch use the following:

$ mkdocs gh-deploy

Changes should shortly appear on the Veres One site.

docs.veres.one's People

Contributors

Watchers

docs.veres.one's Issues

Add community group / mailing list / twitter links

Dev docs should point to community group and mailing list:
https://www.w3.org/community/veres-one/

Also should point to twitter handle:
https://twitter.com/VeresOneID

Merge gh-pages and master branches?

I notice there's both a gh-pages and a master here, slightly out of sync. GitHub now lets you publish master directly on github.io -- might it make sense to combine these two?

Bring did-client README into docs.veres.one

https://github.com/digitalbazaar/did-client#did-client

I was going to send a PR to tweak the current https://github.com/veres-one/docs.veres.one/blob/master/docs/developers/guides/create-did.md instructions (because the npm stuff doesn't work as there's no package.json created, etc). But I then found the did-client instructions--which are more complete and informational.

Not sure how best to sync/connect those two, but I'd recommend at least bringing a copy of the README over in place of the current npm install instructions (which currently don't work).

Cheers!
🎩

Recommend Projects