Skip to content

Commit acb2f15

Browse files
Merge pull request #229 from ThisIs-Developer/docs/international-documentation-audit
docs: overhaul product documentation and localized READMEs
2 parents 5511dc7 + daf0e14 commit acb2f15

23 files changed

Lines changed: 1736 additions & 1253 deletions

CHANGELOG.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -47,8 +47,8 @@ Non-code commits (documentation, planning, README-only updates) are excluded.
4747
## v3.9.0
4848

4949
- **Description:** Introduced clearer sharing flows for Live Share and Share Snapshot, with fixes for shared Markdown rendering and desktop startup.
50-
- **Live Share:** Live Share creates a temporary in-memory room for real-time collaboration. The document is synced only while the room is active, and the room is not saved as a permanent document store. Participants join through the invite link and can either edit or view only, depending on the access mode selected by the host.
51-
- **Share Snapshot:** Share Snapshot creates a shareable read-only or editable snapshot link. Small documents stay encoded directly inside the URL hash. Larger documents are saved behind a generated `#share=` ID and kept temporarily for 90 days, so the recipient can open the shared document without it being stored on their own device.
50+
- **Live Share:** Live Share introduced temporary real-time collaboration through a Cloudflare room. Markdown content is synchronized between active clients rather than stored as a permanent server-side Document. Participants join through the invite link with Can edit or View only access, depending on the mode selected by the host.
51+
- **Share Snapshot:** Share Snapshot creates a point-in-time link with View only or Can edit access. Small documents stay encoded directly inside the `#share=...` URL hash. Larger documents are stored for 90 days and opened through a generated `#id=...` link; recipient tabs remain temporary rather than being added to the saved Workspace.
5252
- **Shared Rendering:** Fixed shared Snapshot and Live Share participant views so LaTeX, Mermaid, TopoJSON, and other advanced Markdown renderers complete after the shared document loads.
5353
- **Sharing UX:** The Live Share modal now shows only the display name, access mode, and start button before a room starts. Participant and invite-link sections appear only after the live room is active.
5454
- **Desktop Startup:** Fixed the Neutralino desktop build preparation so bundled resources load the generated application script instead of stalling on startup skeletons.
@@ -72,9 +72,9 @@ Non-code commits (documentation, planning, README-only updates) are excluded.
7272

7373
## v3.8.0
7474

75-
- **Description:** Delivered substantial new feature expansions and reliability enhancements, including diagram insertion workflow with live card previews, client-side rendering engines (PlantUML, D2, Graphviz), interactive ABC notation playback sync, export quality boosts, desktop data persistence, and layout fixes for squished or overlapping diagrams.
75+
- **Description:** Delivered substantial new feature expansions and reliability enhancements, including diagram insertion with live card previews, PlantUML/D2/Graphviz renderer integrations, interactive ABC notation playback sync, export quality improvements, desktop data persistence, and layout fixes for squished or overlapping diagrams.
7676
- **Insert Diagram Modal:** Added an interactive "Insert Diagram" modal featuring high-fidelity static SVGs, actual live rendering of diagrams in split views, and a categorized search filter.
77-
- **New Diagram Engines Support:** Integrated client-side rendering support for PlantUML, D2, Graphviz (DOT), Vega-Lite, Wavedrom, and Markmap diagrams via dynamic libraries and Kroki API fallbacks for browser/offline environments.
77+
- **New Diagram Engines Support:** Added PlantUML, D2, Graphviz (DOT), Vega-Lite, WaveDrom, and Markmap integrations. The standard web paths use remote PlantUML/Kroki services for remote engines and client-side Markmap libraries.
7878
- **Interactive Diagram Toolbars:** Built interactive toolbar options (zoom, pan, copy SVG/PNG, reset, fit-to-view) for newly introduced engines.
7979
- **ABC Notation Enhancements:** Implemented synchronized playback cursor and note highlighting for synthesized audio playbacks and custom export actions.
8080
- **High-Definition Image Export:** Increased PNG export resolution to 3x for crisp, high-definition diagrams, and added solid backgrounds to transparent SVG renders to preserve visibility.

README.md

Lines changed: 116 additions & 239 deletions
Large diffs are not rendered by default.

desktop-app/README.md

Lines changed: 7 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,12 @@
1-
# Markdown Viewer Desktop App
1+
# Markdown Viewer Desktop Application
22

3-
This folder contains the Neutralinojs desktop wrapper for Markdown Viewer. It turns the browser-based Markdown editor, viewer, and reader into a lightweight desktop build for opening local `.md` files, using split live preview, exporting documents, and working with native file dialogs. It reuses the root web app and adds window lifecycle handling, desktop storage mirroring, and prepared local renderer assets.
3+
This folder contains the Neutralinojs desktop wrapper for Markdown Viewer. It turns the browser-based Markdown editor and viewer into a lightweight desktop build for opening local `.md` files, using Split view and live Preview, exporting Documents, and working with native file dialogs. It reuses the root web app and adds window lifecycle handling, desktop storage mirroring, and prepared local renderer assets.
44

5-
For the complete product behavior and privacy reference, see [../wiki/Features.md](../wiki/Features.md).
5+
For complete product behavior, see [Features](../wiki/Features.md). For storage and network boundaries, see [Privacy and Security](../wiki/Privacy-and-Security.md).
66

77
## Architecture
88

9-
The desktop app shares the same core product code as the browser version:
9+
The desktop application shares the same core product code as the browser version:
1010

1111
- `../index.html`
1212
- `../script.js`
@@ -32,6 +32,7 @@ Desktop-only files:
3232
- A Markdown file passed as a launch argument is loaded into the editor.
3333
- The app asks before closing the window.
3434
- Prepared desktop resources load dynamic libraries from local `/libs/...` paths after setup.
35+
- Private mode and **Reset workspace** clear persisted normal and Secret Workspace Document data. Export needed Documents before using either control.
3536

3637
Network features still use the network when invoked: managed media upload, GitHub import, stored Share Snapshot, Live Share, remote diagram rendering, external images, and external links.
3738

@@ -78,9 +79,9 @@ Native APIs are intentionally allowlisted: app exit, open/save dialogs, message
7879

7980
## Local Renderer Security
8081

81-
Markdown content is treated as untrusted input. The desktop app does not allow Markdown preview rendering to run local shell commands by default. Native file open/save remains available through Neutralino dialogs and filesystem APIs.
82+
Markdown content is treated as untrusted input. The desktop application does not allow Markdown Preview rendering to run local shell commands by default. Native file open/save remains available through Neutralino dialogs and filesystem APIs.
8283

83-
Remote-safe diagram rendering continues to work where supported. Local command renderers such as D2 or PlantUML should only be enabled in a custom build after the user has explicitly accepted that local renderer programs process document content on their machine, and only fixed commands with stdin input should be allowed.
84+
Remote diagram rendering continues to work where supported. PlantUML and D2 use their remote paths in the standard build. Local command renderers should only be enabled in a custom build after the user has explicitly accepted that local renderer programs process Document content on the machine, and only fixed commands with standard input should be allowed.
8485

8586
## Docker Build
8687

0 commit comments

Comments
 (0)