Documentation for all HiGlass software (viewer, app, server, docker)
GitHub Pages hosts the documentation sites, so to make the docs for both the current release and the next release accessible,
we have two repos, higlass-docs
and
higlass-docs-dev
.
Generally, commits should only be made to higlass-docs-dev
, and when we want to release a batch of edits,
we push to a remote for higlass-docs
.
For the time being, after making any edits, the documention should be rebuilt with ./build.sh
,
and the built files should be part of the commit.
For a local preview, run ./serve.sh
.