Skip to content

README.md

Latest commit

 

History

History
17 lines (11 loc) · 990 Bytes

README.md

File metadata and controls

17 lines (11 loc) · 990 Bytes
Raw

Cornerstone docs hub

Landing page for https://docs.cornerstonedata.org, served by GitHub Pages from main.

Each dataset's docs live in their own repo and are published into a folder here by that repo's GitHub Action:

Path Source repo
/eeio/ cornerstone-data/eeio-docs

Don't edit dataset folders by hand; they are overwritten on each deploy. To add a dataset, create a <dataset>-docs repo that publishes into <dataset>/, give it a deploy key with write access here, and add a card to index.html.

Setup

  • Settings → Pages: deploy from branch main, folder /.
  • Custom domain: once the DNS record below exists, add a CNAME file containing docs.cornerstonedata.org (or set it in Settings → Pages) and enforce HTTPS. Adding it before DNS is in place would redirect the site to a domain that doesn't resolve yet.
  • DNS (managed by Watershed): CNAME docs → cornerstone-data.github.io.