Improve documentation SEO and add a Rust-to-Python tutorial - #66
Merged
Merged
Conversation
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.
Make the language documentation easier to discover with descriptive shared-memory IPC titles, and add a runnable Rust publisher → Python subscriber tutorial. The tutorial explains installation, matching queue identity, overlapping endpoint lifetimes, and the limits of delivery guarantees. Link it from the README, documentation overview, and both language guides.
Documentation validation now derives its expected pages from the page manifest, so new or missing pages cannot silently escape the check. The tutorial is included automatically in the sitemap and navigation.
Validation: built and validated all 11 pages; checked all 10 documentation pages in light/dark mode at desktop/mobile widths, including copy buttons and navigation without JavaScript. Installed Python from the published source tag and Rust 3.0.1 from crates.io in a fresh environment on macOS; ran the exact tutorial code as separate processes twice, receiving all five messages in order each time.