From 4370f1259a75ecd4e9111a339f2fb1c27daaa07a Mon Sep 17 00:00:00 2001 From: h3p Date: Wed, 18 Mar 2026 10:56:02 +0100 Subject: [PATCH] docs: fix README layout for pages and mobile --- Neon Vision Editor.xcodeproj/project.pbxproj | 4 +- README.md | 148 +++++++------------ docs/images/architecture-at-a-glance.svg | 110 ++++++++++++++ 3 files changed, 166 insertions(+), 96 deletions(-) create mode 100644 docs/images/architecture-at-a-glance.svg diff --git a/Neon Vision Editor.xcodeproj/project.pbxproj b/Neon Vision Editor.xcodeproj/project.pbxproj index 5c361f1..5993355 100644 --- a/Neon Vision Editor.xcodeproj/project.pbxproj +++ b/Neon Vision Editor.xcodeproj/project.pbxproj @@ -361,7 +361,7 @@ CODE_SIGNING_ALLOWED = YES; CODE_SIGN_IDENTITY = "Apple Development"; CODE_SIGN_STYLE = Automatic; - CURRENT_PROJECT_VERSION = 535; + CURRENT_PROJECT_VERSION = 536; DEAD_CODE_STRIPPING = YES; DEVELOPMENT_TEAM = CS727NF72U; ENABLE_APP_SANDBOX = YES; @@ -444,7 +444,7 @@ CODE_SIGNING_ALLOWED = YES; CODE_SIGN_IDENTITY = "Apple Development"; CODE_SIGN_STYLE = Automatic; - CURRENT_PROJECT_VERSION = 535; + CURRENT_PROJECT_VERSION = 536; DEAD_CODE_STRIPPING = YES; DEVELOPMENT_TEAM = CS727NF72U; ENABLE_APP_SANDBOX = YES; diff --git a/README.md b/README.md index c7f4d3c..96431e7 100644 --- a/README.md +++ b/README.md @@ -40,27 +40,28 @@

Share what works well and what should improve for both the app and the README.

- - - - - - - - - - -
Positive FeedbackNegative Feedback
- - Open Positive Feedback -
- Share positive feedback - 		- - Open Negative Feedback -
- Share negative feedback -
+
+ + + + + + + + + +
Positive FeedbackNegative Feedback
+ + Open Positive Feedback +
+ Share positive feedback + 		+ + Open Negative Feedback +
+ Share negative feedback +
+
> Status: **active release** @@ -318,55 +319,12 @@ Create polished share images directly from your selected code. - Export: use `Share` to generate a PNG snapshot and share/save it. ## Architecture At A Glance - -```mermaid -flowchart LR - Mac["Platform: macOS shell (SwiftUI + AppKit bridges)"] - IOS["Platform: iOS/iPadOS shell (SwiftUI + UIKit bridges)"] - ACT["App Layer: user actions (toolbar/menu/shortcuts)"] - VM["App Layer: EditorViewModel (@MainActor state owner)"] - CMD["App Layer: command reducers (Flux-style mutations)"] - IO["Core: file I/O + load/sanitize pipeline"] - HL["Core: syntax highlighting + runtime limits"] - FIND["Core: find/replace + selection engine"] - PREV["Core: markdown preview renderer"] - SAFE["Core: unsupported-file safety guards"] - STORE["Infra: tabs + session restore store"] - PREFS["Infra: settings + persistence"] - SEC["Infra: SecureTokenStore (Keychain)"] - UPD["Infra: release update manager"] - - Mac --> ACT - IOS --> ACT - ACT --> VM - VM --> CMD - CMD --> STORE - VM --> IO - VM --> HL - VM --> FIND - VM --> PREV - VM --> SAFE - VM --> PREFS - VM --> UPD - PREFS --> STORE - IO --> STORE - VM --> SEC - - classDef platform stroke:#2563EB,stroke-width:3px,fill:transparent,font-family:ui-monospace\, SFMono-Regular\, Menlo\, Monaco\, Consolas\, Liberation Mono\, monospace,font-size:13px; - classDef app stroke:#059669,stroke-width:3px,fill:transparent,font-family:ui-monospace\, SFMono-Regular\, Menlo\, Monaco\, Consolas\, Liberation Mono\, monospace,font-size:13px; - classDef core stroke:#EA580C,stroke-width:3px,fill:transparent,font-family:ui-monospace\, SFMono-Regular\, Menlo\, Monaco\, Consolas\, Liberation Mono\, monospace,font-size:13px; - classDef infra stroke:#9333EA,stroke-width:3px,fill:transparent,font-family:ui-monospace\, SFMono-Regular\, Menlo\, Monaco\, Consolas\, Liberation Mono\, monospace,font-size:13px; - - class Mac,IOS platform; - class ACT,VM,CMD app; - class IO,HL,FIND,PREV,SAFE core; - class STORE,PREFS,SEC,UPD infra; - - linkStyle 0,1 stroke:#2563EB,stroke-width:2px; - linkStyle 2,3 stroke:#059669,stroke-width:2px; - linkStyle 5,6,7,8,9,13 stroke:#EA580C,stroke-width:2px; - linkStyle 4,10,11,12,14 stroke:#9333EA,stroke-width:2px; -``` +

+ + Architecture overview showing platform shells feeding app orchestration, core services, and infrastructure +
+ Static architecture map for GitHub Pages and mobile browsers. +

- `EditorViewModel` is the single UI-facing orchestration point per window/scene. - Commands mutate editor state predictably; session/tabs persist through store services. @@ -454,30 +412,32 @@ Most editor features are shared across macOS, iOS, and iPadOS. ### iPhone - - - - - - - - -
- - iPhone themes panel in light mode -
- Theme customization workflow - 		- - iPhone themes panel in dark mode -
- Dark-theme editing preview -
- - iPhone editor toolbar menu -
- Toolbar Menu Actions -
+
+ + + + + + + + +
+ + iPhone themes panel in light mode +
+ Theme customization workflow + 		+ + iPhone themes panel in dark mode +
+ Dark-theme editing preview +
+ + iPhone editor toolbar menu +
+ Toolbar Menu Actions +
+
## Release Flow (Completed + Upcoming) diff --git a/docs/images/architecture-at-a-glance.svg b/docs/images/architecture-at-a-glance.svg new file mode 100644 index 0000000..c94ac51 --- /dev/null +++ b/docs/images/architecture-at-a-glance.svg @@ -0,0 +1,110 @@ + + + + + Architecture At A Glance + Platform shells route actions into shared app orchestration, core services, and infrastructure. + + + Platform: macOS shell + SwiftUI + AppKit bridges + + + Platform: iOS/iPadOS shell + SwiftUI + UIKit bridges + + + App Layer: user actions + toolbar / menu / shortcuts + + + App Layer: EditorViewModel + @MainActor state owner + + + App Layer: command reducers + predictable state mutations + + + Core: file I/O pipeline + load / sanitize / decode + + + Core: syntax highlighting + runtime limits + + + Core: find / replace + selection engine + + + Core: markdown preview + renderer + export path + + + Core: unsupported-file safety + guardrails + fallback paths + + + Infra: tabs + session restore + window-isolated persistence + + + Infra: settings + persistence + preferences + restore policies + + + Keychain + SecureTokenStore + + + Updater + release manager + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Platform shell + + App orchestration + + Core services + + Infrastructure +