Repository navigation
docs: unify Hyper onboarding for scientists and developers - #12
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
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.
Hyper's onboarding was split across two overlapping documentation PRs, with the main README mixing first-run instructions and detailed reference material. This consolidates #10 and #11 into one change: readers can try the prebuilt viewer, run a complete Python example, or integrate the Rust core from clearly named entry points.
Lead with the native viewer demo and the correct
uvx --python 3.12 --from hypergraph-viz-viewer hypercommand. Explain distribution/import/executable names, build a self-contained Python example with overlapping coauthorship groups, and provide a complete Rust layout example. Keep pip and source builds available, and preserve the expanded viewer reference while aligning its setup with the Python and desktop package guides.For scientific use, distinguish HIF interchange from viewer compatibility, explain approximate hulls and current notebook limits, and link measured benchmarks and reproduction instructions. README research documents ten comparable projects with pinned primary sources and traces the editorial choices to the resulting README.
Validation:
4 layout nodes) and ran the locked offlineproject_sceneexample.git diff --check.Supersedes #10 and #11. Application code and package versions are unchanged.