Rewrite README for signed grid, octant isolation, and CSV-only loading - #45
Merged
Conversation
Contributor
There was a problem hiding this comment.
Pull request overview
Updates README.md to reflect the current Orinoco behavior after PR #42 (signed symmetric grid, octant isolation, scaling modes, tick density, navigation guardrails, and CSV-only loading), removing outdated references to prior grid modes and bundled JSON data.
Changes:
- Documents the symmetric signed grid model, tick density, and scaling modes.
- Adds documentation for octant isolation (gizmo, transition behavior, and isolation reset on CSV load).
- Updates dataset-loading docs to reflect CSV-only loading (including the bundled sample using the same pipeline) and adds navigation guardrails details.
Comments suppressed due to low confidence (2)
README.md:294
- The store field list in the architecture diagram looks exhaustive but is missing active state like
pointSizeScaleandavailableClasses, which are part of the Zustand store. Either include them or indicate the list is partial to avoid drifting documentation.
Store[("Zustand Store: pivot, hoveredPoint, dataPoints, gridSpace, axisLabels, gridVisible, activeTool, hiddenClasses, numericFilters, hiddenTickAxes, scalingMode, customBounds, isolatedOctant, tickDensity")]
README.md:296
- The architecture diagram arrow from
ToolbartoStorelists only a subset of the toolbar-driven actions, but the toolbar also toggles grid visibility, sets tick density, changes active tool, updates point sizing, and manages filters. Listing a broader set (or adding an ellipsis) will keep the diagram accurate.
Toolbar -- "setDataPoints / setScalingMode / setIsolatedOctant" --> Store
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
| C -- Yes --> F[Classify text columns: uid = most unique values, class = remaining column] | ||
| F --> G[setDataPoints in store] | ||
| G --> H[computeGridSpace recomputes scale and ranges] | ||
| G --> H[computeGridSpace recomputes scale, ranges, and octant isolation clears] |
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 README.md to match the codebase after PR #42, verified against actual source (useStore.ts, gridSpace.ts, CartesianGrid.tsx, App.tsx, OctantGizmo.tsx).
Removed: Center Y axis, Standard | Zero plane modes, data.json, icon-strip grid-visibility toggle.
Added: symmetric [-M,+M] grid, octant isolation, three scaling modes, tick density, navigation guardrails, CSV-only loading.