Hypercerts content website - fund and reward impact

We use git submodules to include packages maintained by the Hypercerts Foundation that we use in this project.

To initialize the submodules, run the following command:

git submodule update --init --recursive

Next, install the dependencies:

pnpm install

As this is a Docusaurus project, you can use the following command to start the development server:

pnpm start

To build the project, run the following command:

pnpm build

To serve the built project, run the following command:

pnpm serve

This repository is set up to import documentation from the following packages:

• hypercerts-sdk
• hypercerts-monorepo
• marketplace-sdk

These packages are managed using git submodules.

During the build process we use different processes to generate documentation for these packages.

We use the TypeDoc tool to generate documentation for the hypercerts-sdk package. This tool is used by the docusaurus-plugin-typedoc plugin.

The documentation is generated using the following command:

pnpm build 

We configure the plugin to generate documentation for the hypercerts-sdk package and copy it to the docs/developer/api/hypercerts-sdk directory.

We use hardhat-dodoc to generate documentation for the hypercerts contracts.

The documentation is generated using the following command:

pnpm hardhat dodoc

Note: this step is implicit in the generate:docs script in the package.json file.

Note: this step is implicit in the prebuild script in the package.json file.

This command will generate the documentation for the hypercerts-monorepo package and copy it to the docs/developer/api/contracts directory.

The marketplace SDK is a fork of the LooksRare SDK. The repo has a doc directory that contains the documentation for the SDK.

To make the documentation available for the Docusaurus site, we copy the documentation to the docs/developer/api/marketplace-sdk directory.

pnpm cpx './repos/marketplace-sdk/doc/**/*.md' './docs/developer/api/marketplace-sdk'

Note: this command is run as part of the generate:docs script in the root package.json file.