docs: mention new GH-Pages deployment in README #257
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Before merging mit-dci#255, the gh-pages branch of this repository was used for our live API reference instance. Unfortunately, that branch houses multiple binaries which were rebuilt on every-push, leading to the branch growing in-size without bound, and dramatically increasing the storage and network burden for all clones and forks. Following mit-dci#255 and the deletion of the gh-pages branch, the repo can be cloned almost instantly, and the burden is fully offloaded to a second repository which no one should need to clone under normal circumstances. This commit simply adds reference to the new deployment (since GH's web interface is not smart enough to link to the external repo automatically). Signed-off-by: Sam Stuewe <stuewe@mit.edu>
maurermi
approved these changes
Apr 23, 2024
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Before merging #255, the gh-pages branch of this repository was used for our live API reference instance. Unfortunately, that branch houses multiple binaries which were rebuilt on every-push, leading to the branch growing in-size without bound, and dramatically increasing the storage and network burden for all clones and forks.
Following #255 and the deletion of the gh-pages branch, the repo can be cloned almost instantly, and the burden is fully offloaded to a second repository which no one should need to clone under normal circumstances.
This commit simply adds reference to the new deployment (since GH's web interface is not smart enough to link to the external repo automatically).