Skip to content

Latest commit

 

History

History
59 lines (39 loc) · 1.11 KB

README.md

File metadata and controls

59 lines (39 loc) · 1.11 KB
Raw

docs.nil.foundation

This repository houses the public documentation for =nil; Foundation.

Usage

Clone the repo:

git clone [email protected]:NilFoundation/docs.nil.foundation.git

Install all dependencies:

cd docs.nil.foundation
yarn

Run an interactive preview:

yarn start

Build all docs and serve them locally:

yarn build
yarn serve

Structure

The project follows the monorepo pattern to simplify dependency management.

There exist four separate sets of docs contained in the following folders.

  • ./zkllvm
  • ./proof-market
  • ./nil
  • ./crypto3

Note that only =nil; docs are rendered when running the Docusaurus instance. The rest only exist as collections of raw .md files.

Contributing

Perform the following actions if something needs to be changed in the docs:

  • Click on Issues
  • Select New issue
  • Select a suitable issue template
  • Fill the template and submit the issue

Alternatively:

  • Create a new branch
  • Make the necessary changes
  • Open a PR into main and request a review