Add comprehensive deployment documentation - #961
Merged
Merged
Conversation
The README's Deployment section only covered the Clever Cloud health check. Move it to a dedicated DEPLOYMENT.md that also describes how the website is published from docs/ with GitHub Pages, and how the specref.org zone points the apex and www at GitHub Pages and api at Clever Cloud. Co-Authored-By: Claude Fable 5.1 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_014MHCXm9fYmK4oZ425YG7VZ
…gistrar CORS is enabled so that anyone can consume the API as JSON from a browser, not for the website's benefit. The DNS record values would drift, so point at the providers' documentation instead. Note that the domain is hosted at Namecheap. Co-Authored-By: Claude Fable 5.1 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_014MHCXm9fYmK4oZ425YG7VZ
Co-Authored-By: Claude Fable 5.1 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_014MHCXm9fYmK4oZ425YG7VZ
This file contains hidden or 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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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 PR adds detailed deployment documentation for Specref and updates existing references to point to it.
Summary
Created a new
DEPLOYMENT.mdfile that comprehensively documents how Specref's two independently deployed components (the static website on GitHub Pages and the JSON API on Clever Cloud) are deployed, configured, and how DNS is managed for thespecref.orgdomain.Key changes
New
DEPLOYMENT.md: Comprehensive deployment guide covering:Updated
README.md: Replaced inline deployment instructions with a reference to the newDEPLOYMENT.mdfile, keeping the README focused on usage rather than deployment detailsUpdated
docs/README.md: Added reference toDEPLOYMENT.mdto clarify the GitHub Pages publishing setupUpdated
index.js: Fixed comment reference from README toDEPLOYMENT.mdfor the health check configurationNotable details
The documentation clarifies the independent nature of the two deployments, explains the automatic deployment from the
mainbranch, and provides specific configuration requirements (e.g.,CC_HEALTH_CHECK_PATHenvironment variable for Clever Cloud, custom domain settings for GitHub Pages).https://claude.ai/code/session_014MHCXm9fYmK4oZ425YG7VZ