solace-fi/solace-docs

Website

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

Installation

yarn install

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.

Contract Docgen

Assuming this repo is at ./solace-docs and the core repo is at ./solace-core

mkdir ./solace-core/templates/
cp ./solace-docs/contract.hbs ./solace-core/templates/
cd ./solace-core
npm i
rm -rf docs
mv ./contracts/mocks ./mocks
npx solidity-docgen --solc-module solc-0.8 -t ./templates
mv ./mocks ./contracts/mocks
rm -rf ../solace-docs/docs/dev-docs/Contracts/
cp -r ./docs/. ../solace-docs/docs/dev-docs/Contracts/
cd ../solace-docs
yarn install
python3 scripts/contract_fixes.py
yarn build
yarn start

Upload to AWS

yarn build
aws s3 rm s3://docs.solace.fi --include "*" --recursive
aws s3 cp --recursive --cache-control="max-age=86400" build/ s3://docs.solace.fi/
aws cloudfront create-invalidation --distribution-id E1SZHK4V1QCT0G --paths "/*"
# wait a minute for invalidation to process