oleh/astrolabe
1
0
Fork 0
mirror of https://github.com/olehomelchenko/astrolabe.git synced 2026-08-08 02:02:33 +00:00
Code Issues Packages Projects Releases Wiki Activity

Reconcile §01/§03A spec wording with implemented behavior

Browse Source
This commit is contained in:
Oleh Omelchenko
2026-06-07 18:44:49 +03:00
parent 48c39a600f
commit c7306929cc
2 changed files with 8 additions and 5 deletions
Download Patch File Download Diff File Expand all files Collapse all files
docs/spec/01-application-shell.md
+7 -4
View File
@@ -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_). | | 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_). | | Export | Immediately produces a downloaded file containing all snippets and datasets (see _Import & Export_). |
| Datasets | The Datasets manager modal (see _Datasets_). | | 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). | | About & Privacy | The About & Help modal (keyboard shortcuts, about, and privacy information). |
| Donate | The Donate modal. | | Donate | The Donate modal. |
Notes: Notes:
- Import and Export act directly (file dialog / file download); they do not open in-app modals. - 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 ## 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. - 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. - 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 + Shift + N | Create a new snippet (see _Snippet Library_) |
| Cmd/Ctrl + K | Toggle the Datasets manager open/closed | | 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 + 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 | | Escape | Close the active modal |
Notes: Notes:
docs/spec/03-editor-and-drafts.md
+1 -1
View File
@@ -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. - 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. - 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). - 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'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. - 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.