Rewrite USER_GUIDE.md for signed grid, octant isolation, and CSV-only loading - #44
Merged
Conversation
Contributor
There was a problem hiding this comment.
Pull request overview
Updates the end-user documentation to reflect the post-#42 UI/feature set (signed symmetric grid, scaling modes, octant isolation, CSV-only loading, and navigation guardrails), removing references to retired controls and troubleshooting notes.
Changes:
- Refreshes the “first look” and Grid page documentation to match the signed/symmetric grid and new scaling + tick controls.
- Adds documentation for the new Isolate page (octant gizmo behavior) and camera/navigation guardrails.
- Updates toolbar and troubleshooting sections to reflect removed toggles and new filtering/isolation behavior.
Comments suppressed due to low confidence (3)
USER_GUIDE.md:231
- The guide references
docs/images/filter.jpg, but there is nofilter.jpg(or similarly named Data-page screenshot) indocs/images/, so this will render as a broken image. Either add the image file or update the link to an existing asset.
USER_GUIDE.md:285
- This screenshot link targets
docs/images/isolate.cube.jpg, butdocs/images/currently does not contain that file, so the image will be broken in rendered docs. Either add the screenshot file (recommended) or remove/update the reference.
USER_GUIDE.md:423
- This screenshot link points to
docs/images/hud.jpg, butdocs/images/does not contain that file, so the image won’t render. Either add the HUD screenshot asset or remove/update this reference.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
| - **A HUD panel** in the top-left showing the currently hovered point's metadata | ||
| - **A toolbar** docked to the right edge for data and display controls | ||
|
|
||
|  |
| | **Shift** | Lower pivot along the Y axis | | ||
|
|
||
| When the pivot changes, the camera translates by the same offset, preserving your viewing angle. The pivot is marked by a **six-armed cross reticle** in the scene. | ||
| When the pivot changes, the camera translates by the same offset, preserving your viewing angle. The pivot is marked by a **six-armed cross reticle** at the origin. |
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.
Rewrites USER_GUIDE.md to match the codebase after PR #42.
Removed (no longer exist):
Added (new in #42):
Also removed the "camera feels slightly off" troubleshooting entry and its GitHub issue references — a user guide shouldn't cite internal issue trackers or describe implementation-level causes; the existing "camera is lost" entry already covers the fix (Reset).
No code changes — documentation only.