Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

EPIC Documentation #38

Open
infinitron opened this issue Jul 22, 2022 · 0 comments
Open

EPIC Documentation #38

infinitron opened this issue Jul 22, 2022 · 0 comments
Labels
documentation Improvements or additions to documentation enhancement New feature or request

Comments

@infinitron
Copy link
Contributor

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?
@infinitron infinitron added documentation Improvements or additions to documentation enhancement New feature or request labels Jul 22, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
documentation Improvements or additions to documentation enhancement New feature or request
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
1 participant
@infinitron