Consolidate website documentation and prevent stale deployed assets - #65
Merged
Merged
Conversation
Deploying cloudtoid with
|
| Latest commit: |
8c1e4d5
|
| Status: | ✅ Deploy successful! |
| Preview URL: | https://32b22673.cloudtoid.pages.dev |
| Branch Preview URL: | https://codex-website-asset-cache.cloudtoid.pages.dev |
prezaei
changed the title
prezaei
changed the title
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
1 participant
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.
Browsers could retain old styles and scripts for four hours after a website deployment. Generate content-hashed asset URLs so new HTML loads the matching assets. Validate those hashes and document the corrected Cloudflare build-watch pattern.
Make the website the main documentation destination. Link the root and six package READMEs to their API guides and remove duplicated reference explanations, retaining installation commands, short examples, lifetime notes, benchmarks, and contributor instructions.
Move the complete protocol specification to /docs/protocol/ and remove the old Markdown copy. Add an interactive queue illustration above the spec showing concurrent publisher reservations, paused publication and ordering, full capacity, receive/reuse, and circular buffer wraparound. Update all protocol links, navigation, sitemap, and metadata. The full specification remains available without JavaScript.
Validation:
Point all getting-started and installation-guide links to the website, including language-specific package metadata for Cargo, NuGet, npm, and Python. Move C source-install instructions onto the C guide. Package registry links remain direct; metadata updates take effect on the next package release. Cargo metadata, package JSON/XML, static build, and site link validation pass.