epic-astronomy / LWA_EPIC

The LWA-specific implementation of the EPIC correlator
http://livetv.epic-astronomy.org
MIT License
3 stars 3 forks source link

EPIC Documentation #38

Open infinitron opened 2 years ago

infinitron commented 2 years ago

I think it would be good to have EPIC and its setup-related code documented somewhere. I prefer to use gitbooks, but I'm fine with anything else like readthedocs. I suggest we maintain a separate repo for the docs and add it as a submodule to all the projects. It would be easier to maintain, especially with the upcoming transient detection and alert stacks, where we need to document the associated system designs too.

If it's going to be gitbooks, we need to apply for the free community edition soon as it takes some time for them to review. The pro version starts at ~$7 per month with the added benefit of private spaces where we can host the internal details. What do you guys think?