Hosting a docs page on internet that gets built by CI

[adam2392]

Summary

So was thinking where should we host a documentation page and should they be separate on repos and link to each other, or on one repo?

Possible Solutions

Option 1:
SEEK has its own doc page on how to run workflows that then connect to a visualization engine

ReconstructionVisualizer then has its own docs page that links to SEEK to specify what data inputs it wants.

Option 2:

Aggregated docs page here?

Then these should be ideally rendered during CI for every PR and master branch commit.

[TheBrainChain]

I think we solved this, right?
SEEKs github action will build the docs and push them to this repo. This repo's github action will build the generator and visualize docs, as well as create a new docker image. As soon as that docker image is built it update's our Azure demo site and all documentation can be viewed here: http://neuroseek.azurewebsites.net/docs/

[adam2392]

Oh yeah this is outdated now.

One thing that we could discuss is perhaps moving docs hosting to a diff branch? And then that way when we build prs on this repo which get merged to master we don't need to sync in the doc changes (pushed by seek)?

E.g. currently:

1. Seekpipeline say makes a change in docs and it pushes here for hosting
2. We make a change here in a PR branch
3. We need to git sync master branch again cuz docs changed.

Alternatively

1. Seekpipeline makes changes. It pushed doc changes to 'docs' branch here to be re rendered.
2. We make changes here in a PR branch
3. When we merge into master, it gets pushed to 'docs' branch and is re rendered.

But then this can bring up complications:

1. How do we make the docs appear in CI for every PR here? Possibly not even a problem tho depending on how docs build and deployment occurs.
2. Any other challenges?

If it's rather challenging overhaul might not be necessary to tackle now.