dev-site.md

How to deploy our developer site(dev-site)

1. Checkout to gh-pages which is the branch of dev-site

$ cd $(islet-project/islet)
$ git checkout gh-pages

2. Rebase to latest main branch

$ git rebase main

3. Generate dev-site docs

$ ./scripts/make_doc.sh

4. Commit the result docs

$ git add docs/*
$ git commit -s -m "Bump to latest main branch"

5. Deploy the docs to the remote site

$ git push origin gh-pages --force

That's it! You can check the status of deploy here.