Skip to content

docs: simplify README and expand viewer guide - #10

Closed
bregydoc wants to merge 1 commit into
mainfrom
codex/simplify-readme
Closed

bregydoc wants to merge 1 commit into
mainfrom
codex/simplify-readme

Conversation

@bregydoc

@bregydoc bregydoc commented Oct 4, 2026

Copy link
Copy Markdown
Collaborator

The README mixed getting started with API internals, benchmark analysis, and detailed viewer behavior. Shorten it from 433 to 161 lines and lead with installation, the built-in demo, and small Python and JSON examples.

Move the full controls, display settings, schema fields, and session reference into the viewer guide. Fix that guide's sample graph to declare every referenced vertex.

Validation:

  • Checked local links, anchors, code fences, JSON membership references, and Python example syntax.
  • Ran cargo run --locked --offline -p hyper-viz --example project_scene successfully.
  • Confirmed the published Python viewer extra and platform wheels through PyPI metadata.
  • git diff --check passes.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant