Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This adds support for loading the markdown and JSON from remote servers
by using
open-uri
. This means the docs can live outside of theapplication server and not need to be generated or checked into the app.
The usecase for doing this is so that a Continuous Integration (CI)
server can generate the docs since it is already setup for the test
environment, which RAD requires. Then, after generation, it uploads the
RAD docs (JSON and markdown files) to a static file host, like AWS S3,
and then those docs get served to the application environments when
viewing the API docs.
This lets the docs be viewed in live application environments without
checking the docs into the app since they may change often.
Let me know if this change is fitting for Apitome; if not, no worries. If I
need to add specs or adjust the Ruby style, totally let me know.
Thanks for building such a great doc viewer. 😄