Repository navigation
Resolve documentation inconsistencies against the code #153
Description
07 · Resolve documentation inconsistencies
Parent: #146 (Epic: Rebrand Data Visualizer as DxVisualizer)
Labels: documentation, triage
Summary
INCONSISTENCIES.md lists contradictions found while preparing the rebrand.
Most are fixed in the handoff copy. Three need a decision against the code
before the docs can be correct.
Needs decision
- I-01 Processor with no
Acceptslist.managing-assets.mdsays it
applies to every type;extending.mdsays it is never offered. Check the
discovery code and correct the wrong page. - I-02 Where pane widths live.
organizing.mdsays widths are saved per
user in editor preferences, independent of the persistence setting, and
later says they "stay with theDataVisualizerSettingsasset". Check the
code and correct one section. - I-03 Persistence toggle label. The docs call it Persist State in
UserState (on by default); the settings capture reads Persist State
in Settings Asset. Align the label and the docs; the redesign replaces
the toggle with a User state / Project asset switch.
Already fixed in the handoff copy
- I-04 Row actions location in Getting started.
- I-05 Mixed "DataVisualizer" / "Data Visualizer" in the theme menu path.
- I-06 Package description out of step with the site.
- I-07 to I-08 README voice and duplication.
- I-10 Theme count.
- I-12 Video walkthrough predates the rename.
Acceptance criteria
- Each needs decision item has a recorded answer in this issue and the
docs match the code. - A docs test or a short check list in the PR confirms the three behaviors
in the editor.
Activity
wallstop commentedon Oct 10, 2026
DISCLOSURE: LLM-GENERATED TEXT
Recorded answers for the three needs-decision items, checked against the code, delivered in PR #164:
I-01 Processor with no
Acceptslist.extending.mdwas right;managing-assets.mdwas wrong. Discovery iteratesTypeCache.GetTypesDerivedFrom<IDataProcessor>(), and the compatibility pass skips every processor whoseAcceptsisnull(foreach (Type acceptedType in processor.Accepts)runs only after the null checkcontinues); the Processors area hides entirely when nothing matches the selected type.managing-assets.mdnow says a processor with noAcceptslist is never offered.I-02 Where pane widths live. The splitter widths persist through the
EditorPrefskeysDataVisualizer.SplitterOuterFixedPaneWidth/SplitterInnerFixedPaneWidth, read on window build and independent of the persistence setting. The "What is never shared" section oforganizing.mdwrongly bundled pane widths with the settings asset; it now lists only the Data Folder andselectActiveObject, both of which serialize onDataVisualizerSettings, and states that pane widths always stay in editor preferences.I-03 Persistence toggle label. The toggle names the mode you would switch to: with
persistStateInSettingsAssetat its defaultfalse, the label reads Persist State in Settings Asset and state is written as JSON toDataVisualizerUserState.jsoninApplication.persistentDataPath; switching on stores it in theDataVisualizerSettingsasset. The docs now use the on-screen label and describe the default as off. While verifying, the[Tooltip]on the field turned out to have the two save locations swapped; it now matches the field. The User state / Project asset switch stays with the redesign as noted.I-04..I-06 are now fixed in the repository too: the handoff copy they were "already fixed" in was never merged, so the row-actions sentence, the menu paths, and the prose name needed applying to the current docs.
Evidence in the diff: the tooltip and label strings in
Editor/DataVisualizer/Data/DataVisualizerSettings.csandEditor/DataVisualizer/DataVisualizer.cs, plus the doc edits in PR #164.Match docs to the window, trim check loops (#164)
Adopt the kit's docs site and migration and roadmap pages
Adopt the kit's docs site and new pages (#167)