AlexandriaILS / Alexandria

Open Source Integrated Library System
1 stars 2 forks source link

RFC: move compiled documentation into codebase #19

Open itsthejoker opened 2 years ago

itsthejoker commented 2 years ago

One of the prevailing thoughts of deployable software is to vendor everything, i.e. have everything needed included with the application and pull in basically nothing. We already vendor most of the JS we need (need to still vendor Bootstrap but that's a different issue) and the question occurred to me as to whether we should include the compiled output of retype in the docs folder and use something like srcdocs for the markdown source BECAUSE retype is a node js / dotnet application and we can't vendor that.

The idea then would be to add a route in nginx so that the compiled documentation is always available, i.e. example.com/docs/..., but only if the deploying party decides to add the docs route (something that can be added into the documentation).

Downsides:

Advantages:

itsthejoker commented 2 years ago

Update: retype does not work for precompiled local docs. It's something that's on the roadmap, but presently is not feasible. https://github.com/retypeapp/retype/discussions/194