This website is built using Docusaurus 2.
The documentation
folder is split into the following parts:
docs
tutorials
sdk
api
documentation/docs
is a general documentation directory for:
- Getting started guides
- SSI and Atala concepts
- Atala PRISM architecture and components description
documentation/tutorials
directory assigned to contain all tutorials about essential topics and protocols Atala PRISM V2 is supported, for example:
- Credential issuance
- Verification
- DIDs
- etc.
documentation/sdk
is a special directory for SDK documentation, user guides, and examples. There are two subfolders:
enterprise-sdk
: for what we call now "Enterprise SDK"wallet-sdk
: for what we call now "Wallet SDK"
documentation/api
directory contains auto-generated documentation for RestAPI endpoints provided by Atala PRISM V2 executables, it's auto-generated and should not be added manually.
Here are the simple installation instructions for MacOS to start from the very scratch.
# Install brew, git, node and yarn
# If you have these tools, skip these steps
/bin/bash -c "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/HEAD/install.sh)"
brew install git
brew install node
brew install yarn
# Create new projects directory
cd ~ && mkdir projects && cd projects
git clone https://github.com/input-output-hk/atala-prism-docs.git
# Initialize submodules
git submodule init
# Update submodules
git submodule update --remote --recursive
# Use this step to checkout custom branch to review from PR
# git checkout feature-branch
# Deploy local version of the website
cd atala-prism-docs
yarn install
yarn start
$ 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.
$ yarn build --out-dir infra/website
This command creates a set of static resources which can be hosted to serve the full site.