Skip to content

ERDW_HowCurrentDocsAreBuilt

EricZinda edited this page Mar 27, 2023 · 8 revisions

This page describes how the previous (as of 8/15/22) docs were built.

Delph-in Wiki

The "official" DELPH-IN wiki uses the Github wiki feature. That means that it is a special wiki repository tied to a "regular" Github repository: https://github.com/delph-in/docs.

If you go to the docs repository and look at the source in it, there is very little. To see the actual source for the wiki pages, you have to find the wiki repository: Click on the "wiki" link on top of the docs repository, look at the bottom of the right hand column on that new page. You'll see UI for "Clone this wiki locally". If you clone it, you'll see all the wiki pages there. I haven't found a way to actually browse the source using the normal github repository browser, I think you just have to clone it.

delph-in.github.io/docs/

The "official docs" were created using Github Pages and are hosted at https://delph-in.github.io/docs/. If you went to that page, you'd see a (small number of) pages from the https://github.com/delph-in/docs repository there. These get built and pushed to https://delph-in.github.io/docs/ by Github automatically whenever anyone pushes a change to the delph-in/docs repository.

One "trick" that happened on the old https://delph-in.github.io/docs/ page is the search box. This was set up to post to the same URL the wiki uses for its search.

Clone this wiki locally