From c7306929cc01e55af31cf5de20525435aa0dc8c7 Mon Sep 17 00:00:00 2001 From: Oleh Omelchenko Date: Sun, 7 Jun 2026 18:44:49 +0300 Subject: [PATCH] =?UTF-8?q?Reconcile=20=C2=A701/=C2=A703A=20spec=20wording?= =?UTF-8?q?=20with=20implemented=20behavior?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- docs/spec/01-application-shell.md | 11 +++++++---- docs/spec/03-editor-and-drafts.md | 2 +- 2 files changed, 8 insertions(+), 5 deletions(-) diff --git a/docs/spec/01-application-shell.md b/docs/spec/01-application-shell.md index f255085..ca5952c 100644 --- a/docs/spec/01-application-shell.md +++ b/docs/spec/01-application-shell.md @@ -32,18 +32,21 @@ A fixed header spans the top of the app. | Import | A file-picker dialog to choose a previously exported file; the chosen file is imported (see _Import & Export_). | | Export | Immediately produces a downloaded file containing all snippets and datasets (see _Import & Export_). | | Datasets | The Datasets manager modal (see _Datasets_). | -| Settings | The Settings modal (see _Settings_). | | About & Privacy | The About & Help modal (keyboard shortcuts, about, and privacy information). | | Donate | The Donate modal. | Notes: - Import and Export act directly (file dialog / file download); they do not open in-app modals. -- The Datasets, Settings, About & Privacy, and Donate entry points each open a modal (see _Modal System_). +- The Datasets, About & Privacy, and Donate entry points each open a modal (see _Modal System_). +- **Settings are not a header entry point.** A design review (see _Settings_) distributed + preferences to the panes they affect — the appearance theme is a header toggle, and the + Editor / Performance / Formatting clusters open from a gear control in their own pane. There + is no central Settings button or modal. ## C. Modal System -The app shows at most one modal at a time. The modal set is: Datasets, Settings, About & Help, Donate, Chart Builder, and Extract-to-Dataset. +The app shows at most one modal at a time. The modal set is: Datasets, About & Help, Donate, Chart Builder, and Extract-to-Dataset. (Settings are deliberately _not_ a modal — they are distributed to per-pane controls; see _Settings_.) - Opening any modal closes whichever modal was previously open; the two never overlap. - Every modal can be dismissed by: clicking its close button, pressing **Escape**, or clicking the backdrop outside the modal body. @@ -60,7 +63,7 @@ Shortcuts are platform-aware: the modifier is **Cmd** on Mac and **Ctrl** on oth | Cmd/Ctrl + Shift + N | Create a new snippet (see _Snippet Library_) | | Cmd/Ctrl + K | Toggle the Datasets manager open/closed | | Cmd/Ctrl + S | Publish the current snippet's draft (see _Spec Editor & Draft/Published Workflow_) | -| Cmd/Ctrl + , | Open the Settings modal | +| Cmd/Ctrl + , | Open the Editor settings cluster (see _Settings_) | | Escape | Close the active modal | Notes: diff --git a/docs/spec/03-editor-and-drafts.md b/docs/spec/03-editor-and-drafts.md index 8a19835..82acabd 100644 --- a/docs/spec/03-editor-and-drafts.md +++ b/docs/spec/03-editor-and-drafts.md @@ -9,7 +9,7 @@ The editor presents the active snippet's spec as formatted JSON with full code-e - The editor displays the spec as indented, readable JSON with syntax highlighting. - As the user types, the spec is validated against the Vega-Lite schema; problems are surfaced as inline indicators at the offending locations (e.g. squiggles/markers), without blocking continued editing. - The editor offers schema-driven autocomplete/suggestions while typing (property names and allowed values from the Vega-Lite schema). -- Pasting content and typing trigger automatic reformatting so the JSON stays consistently indented. +- Pasting content reformats the spec automatically so it stays consistently indented; while typing, the editor maintains consistent indentation as new lines are entered (auto-indent). A format-on-demand action reflows the whole spec to the same compact, readable style. - The editor's appearance and behavior — font size, editor theme, minimap visibility, word wrap, line numbers, and tab size — are configurable and read from _Settings_; this section does not redefine their defaults. - The editor always edits a single active snippet. Selecting a different snippet in the _Snippet Library_, or toggling the Draft/Published view, replaces the editor content with the corresponding spec.