diff --git a/doc/HACKING.md b/doc/HACKING.md new file mode 100644 index 000000000..b8f8ae54e --- /dev/null +++ b/doc/HACKING.md @@ -0,0 +1,13 @@ +# Updating the gh-pages (zdharma-continuum.github.io) + +1. Check out the [documentation branch](https://github.com/zdharma-continuum/zinit/tree/documentation) +```shell +git fetch origin documentation +git checkout documentation +``` +2. Do your modifications and push your changes +3. Keep an eye on [the CI logs](https://github.com/zdharma-continuum/zinit/actions/workflows/gh-pages.yaml) +4. If all went well you can head to https://zdharma-continuum.github.io/ to see your changes live. + +**NOTE:** If you really **need** to push directly, without CI please refer to +[the README in the documentation]https://github.com/zdharma-continuum/zinit/blob/documentation/README.md