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

Host mdbook docs on github pages #120

Open
senekor opened this issue Jul 16, 2023 · 1 comment
Open

Host mdbook docs on github pages #120

senekor opened this issue Jul 16, 2023 · 1 comment
Assignees
@senekor

Comments

@senekor
Copy link
Owner

senekor commented Jul 16, 2023

so that documentation is always available, without an instance being publicly hosted.
@senekor senekor self-assigned this Jul 16, 2023
@senekor
Copy link
Owner Author

senekor commented Dec 12, 2023

Versioning could be a bit of an issue. Assume some deployment is a few releases behind and out-of-sync with the latest documentation. It might make sense to not have that documentation on github pages at all, to avoid confusion. Or split the documentation up somehow. E.g. the user manual would only be available from a deployed instance. Things like migration guides would obviously be available centrally.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@senekor senekor

Labels
None yet
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
1 participant
@senekor