Skip to content

Commit 41c6809

Browse files
authored
Merge pull request #211 from beNative/codex/review-documentation-for-recent-commits
Document v0.6.9 features and UI updates
2 parents 3b8e21b + e7ceea5 commit 41c6809

File tree

6 files changed

+36
-30
lines changed

6 files changed

+36
-30
lines changed

FUNCTIONAL_MANUAL.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -28,6 +28,7 @@ The resizable left panel is your main navigation and organization area.
2828
- **Search:** A search bar at the top lets you filter your documents and folders. It instantly checks titles while also running a background full-text search across document bodies, returning contextual snippets with the matched terms highlighted so you can quickly confirm relevance.
2929
- **Documents List:** A hierarchical tree view of all your documents and folders.
3030
- **Action Toolbar:** A toolbar at the top of the list provides icon buttons to quickly create a new document, create a new root folder, create a new document from a template, expand/collapse all folders, and toggle the active document's lock state.
31+
- **Row Quick Actions:** Hover or focus any row to reveal a compact strip of icons for the most common tasks—duplicate, export, rename, lock/unlock (for editable repositories), and more. The quick actions float over the right edge so the row keeps its full height and the title stays readable.
3132
- **Folders:** Can be expanded or collapsed.
3233
- **Documents:** Individual document files. Selecting a document opens it in the Main Content Area.
3334
- **Templates List:** A separate panel below your documents for managing reusable templates. This panel is resizable; you can drag its top border to adjust its height.
@@ -115,8 +116,10 @@ The document editor is powered by Monaco, the same editor core used in VS Code,
115116
- **Editor Only:** The default text editing view.
116117
- **Preview Only:** A rendered view of your content.
117118
- **Split Vertical/Horizontal:** A side-by-side or top-and-bottom view of the editor and the live preview.
119+
- **Aligned Controls:** The language selector, Cancel Changes button, and preview toggles are grouped together so the toolbar stays organized even as you resize the window.
118120
- **Toolbar Actions:**
119121
- **Save Version:** Manually save the current content as a new version in the document's history. The button icon will be highlighted when there are unsaved changes.
122+
- **Cancel Changes:** Discard all unsaved edits and revert to the last saved version without closing the tab or navigating away.
120123
- **Version History:** Open a view to see all saved versions of the document.
121124
- **Format:** Automatically tidy up supported languages—Markdown, JSON, JavaScript, and TypeScript—using DocForge's integrated formatter.
122125
- **Lock/Unlock:** Click the padlock icon to switch the document between editable and read-only modes. Locked documents disable title regeneration, formatting, AI refinement, and manual saves until you unlock them.

README.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -11,12 +11,14 @@ DocForge is a desktop application designed to streamline the process of creating
1111
- **Full Context Menu & Keyboard Navigation:** Navigate and manage items using a complete right-click context menu or use only the keyboard for a faster workflow.
1212
- **Universal Monaco Editor:** A powerful, VS Code-like editor is used for all document types, including Markdown, HTML, and various source code files, with syntax highlighting and code folding.
1313
- **One-Click Formatting:** Clean up Markdown, JSON, JavaScript, and TypeScript documents directly from the editor toolbar.
14+
- **Cancel Unsaved Changes:** Instantly roll a document back to its last saved state with a dedicated toolbar button when an experiment goes sideways.
1415
- **Document Locking:** Protect sensitive drafts by toggling a padlock button that flips the editor into a read-only mode until you intentionally unlock it.
1516
- **Multi-Document Tabs:** Keep several documents open at once, pin important files, and quickly jump between them using the tab strip and overflow picker.
1617
- **Multi-Format Live Preview:** Get a real-time, rendered preview for Markdown, HTML, PDFs, and common image formats. The preview can be displayed side-by-side (vertically or horizontally) with the editor, and binary formats open straight into preview mode with zoom and pan controls tailored to each viewer.
1718
- **AI-Powered Refinement:** Use your connected local LLM to automatically refine and improve your documents with a single click.
1819
- **Document Templating:** Create reusable document templates with variables to quickly generate new documents for recurring tasks.
1920
- **Document Export:** Save any document to your filesystem with a suggested filename and the correct extension for its detected type, whether you're running the Electron app or using the browser build.
21+
- **Hover-First Tree Actions:** Keep document titles readable while revealing quick actions—duplicate, export, lock, etc.—only when you hover or focus each row in the sidebar.
2022
- **Integrated Python Workflow:** Open an inline Python console tied to your documents to execute snippets, review logs, and manage isolated environments without leaving DocForge.
2123
- **Shell & PowerShell Execution:** Run or syntax-test scripts directly from the editor with per-document environment overrides that merge with workspace defaults configured in Settings.
2224
- **Version History:** Explicitly save new versions of your documents. Manage your history by viewing diffs, deleting old versions, and restoring to any point in time.

VERSION_LOG.md

Lines changed: 13 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -1,24 +1,27 @@
11
# Version Log
22

3-
## v0.6.9 - The Release Prep Maintenance
3+
## v0.6.9 - The Workflow & Execution Update
4+
5+
### ✨ Features
6+
7+
- Added Save to File actions across the document tree, editor toolbar, and command palette so any document can be exported with a context-aware filename and extension.
8+
- Introduced Shell and PowerShell execution panels that let you test or run scripts with per-document environment overrides, surfaced logs, and remembered histories alongside the existing Python runner.
9+
- Added a Cancel Changes button to the editor toolbar, enabling you to instantly discard unsaved edits and return to the last saved version without leaving the document.
10+
- Enabled document locking throughout the UI so a quick padlock toggle puts the editor into read-only mode, preventing accidental saves, formatting, or AI refinements until you explicitly unlock it again.
11+
- Refined the sidebar tree so quick actions collapse into an icon row on hover, labels maintain their full width, and repository-backed nodes display a lock toggle beside other controls.
12+
- Polished the editor toolbar layout by grouping the language selector and preview controls, keeping the action cluster aligned even as the window resizes.
413

514
### 🐛 Fixes
615

716
- Updated the release workflow fixtures to validate the `v0.6.9` tag and installers, keeping the automated publishing checks aligned with the shipped binaries.
817

918
### 📝 Documentation
1019

11-
- Refreshed the release preparation guides so every README and manual references the `v0.6.9` tagging flow and synchronized documentation updates.
12-
13-
## Unreleased - The Document Export Primer
20+
- Refreshed the release preparation guides so every README and manual references the `v0.6.9` tagging flow, the new export workflow, and script execution guidance.
1421

15-
### ✨ New
22+
## Unreleased
1623

17-
- Added a Save to File action throughout the document tree and command palette so any document can be exported with a context-aware filename and extension.
18-
19-
### 📝 Documentation
20-
21-
- Documented the export workflow across the README and manuals, including technical notes about the new `documentExportService` and how the Electron bridge streams files to disk.
24+
- _No entries yet._
2225

2326
## v0.6.8 - The Shortcut & Clipboard Update
2427

@@ -53,11 +56,6 @@
5356
- Integrated GitHub Spec Kit workflows and refreshed assets so future changes
5457
arrive with automated specification checks.
5558

56-
> TODO: Document how to clear or reset keyboard shortcuts in the Functional
57-
> Manual's settings chapter.
58-
> TODO: Call out PlantUML and TOML syntax coverage in the published manuals so
59-
> users can discover the new language support.
60-
6159
## v0.6.7 - The Auto-Update Reliability Pass
6260

6361
### ✨ Features

docs/FUNCTIONAL_MANUAL.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -28,6 +28,7 @@ The resizable left panel is your main navigation and organization area.
2828
- **Search:** A search bar at the top lets you filter your documents and folders. It instantly checks titles while also running a background full-text search across document bodies, returning contextual snippets with the matched terms highlighted so you can quickly confirm relevance.
2929
- **Documents List:** A hierarchical tree view of all your documents and folders.
3030
- **Action Toolbar:** A toolbar at the top of the list provides icon buttons to quickly create a new document, create a new root folder, create a new document from a template, expand/collapse all folders, and toggle the active document's lock state.
31+
- **Row Quick Actions:** Hover or focus any row to reveal a compact strip of icons for frequent tasks—duplicate, export, rename, lock/unlock (for editable repositories), and more. The controls float on the right edge so the row height stays consistent and labels retain their full width.
3132
- **Folders:** Can be expanded or collapsed.
3233
- **Documents:** Individual document files. Selecting a document opens it in the Main Content Area.
3334
- **Templates List:** A separate panel below your documents for managing reusable templates. This panel is resizable; you can drag its top border to adjust its height.
@@ -115,8 +116,10 @@ The document editor is powered by Monaco, the same editor core used in VS Code,
115116
- **Editor Only:** The default text editing view.
116117
- **Preview Only:** A rendered view of your content.
117118
- **Split Vertical/Horizontal:** A side-by-side or top-and-bottom view of the editor and the live preview.
119+
- **Aligned Controls:** The language selector, Cancel Changes button, and preview toggles are grouped together so the toolbar stays organized even as you resize the window.
118120
- **Toolbar Actions:**
119121
- **Save Version:** Manually save the current content as a new version in the document's history. The button icon will be highlighted when there are unsaved changes.
122+
- **Cancel Changes:** Discard all unsaved edits and revert to the last saved version without closing the tab or navigating away.
120123
- **Version History:** Open a view to see all saved versions of the document.
121124
- **Format:** Automatically tidy up supported languages—Markdown, JSON, JavaScript, and TypeScript—using DocForge's integrated formatter.
122125
- **Lock/Unlock:** Click the padlock icon to switch the document between editable and read-only modes. Locked documents disable title regeneration, formatting, AI refinement, and manual saves until you unlock them.

docs/README.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,9 @@ DocForge is a desktop application designed to streamline the process of creating
1414
- **AI-Powered Refinement:** Use your connected local LLM to automatically refine and improve your documents with a single click.
1515
- **Document Templating:** Create reusable document templates with variables to quickly generate new documents for recurring tasks.
1616
- **Document Export:** Save any document to your filesystem with a suggested filename and the correct extension for its detected type, whether you're running the Electron app or using the browser build.
17+
- **Cancel Unsaved Changes:** Instantly roll a document back to its last saved state with a dedicated toolbar button when an experiment goes sideways.
1718
- **Document Locking:** Protect sensitive drafts by toggling a padlock button that flips the editor into a read-only mode until you intentionally unlock it.
19+
- **Hover-First Tree Actions:** Keep document titles readable while revealing quick actions—duplicate, export, lock, etc.—only when you hover or focus each row in the sidebar.
1820
- **Integrated Python Workflow:** Open an inline Python console tied to your documents to execute snippets, review logs, and manage isolated environments without leaving DocForge.
1921
- **Shell & PowerShell Execution:** Run or syntax-test scripts directly from the editor with per-document environment overrides that merge with workspace defaults configured in Settings.
2022
- **Version History:** Explicitly save new versions of your documents. Manage your history by viewing diffs, deleting old versions, and restoring to any point in time.

docs/VERSION_LOG.md

Lines changed: 13 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -1,24 +1,27 @@
11
# Version Log
22

3-
## v0.6.9 - The Release Prep Maintenance
3+
## v0.6.9 - The Workflow & Execution Update
4+
5+
### ✨ Features
6+
7+
- Added Save to File actions across the document tree, editor toolbar, and command palette so any document can be exported with a context-aware filename and extension.
8+
- Introduced Shell and PowerShell execution panels that let you test or run scripts with per-document environment overrides, surfaced logs, and remembered histories alongside the existing Python runner.
9+
- Added a Cancel Changes button to the editor toolbar, enabling you to instantly discard unsaved edits and return to the last saved version without leaving the document.
10+
- Enabled document locking throughout the UI so a quick padlock toggle puts the editor into read-only mode, preventing accidental saves, formatting, or AI refinements until you explicitly unlock it again.
11+
- Refined the sidebar tree so quick actions collapse into an icon row on hover, labels maintain their full width, and repository-backed nodes display a lock toggle beside other controls.
12+
- Polished the editor toolbar layout by grouping the language selector and preview controls, keeping the action cluster aligned even as the window resizes.
413

514
### 🐛 Fixes
615

716
- Updated the release workflow fixtures to validate the `v0.6.9` tag and installers, keeping the automated publishing checks aligned with the shipped binaries.
817

918
### 📝 Documentation
1019

11-
- Refreshed the release preparation guides so every README and manual references the `v0.6.9` tagging flow and synchronized documentation updates.
12-
13-
## Unreleased - The Document Export Primer
20+
- Refreshed the release preparation guides so every README and manual references the `v0.6.9` tagging flow, the new export workflow, and script execution guidance.
1421

15-
### ✨ New
22+
## Unreleased
1623

17-
- Added a Save to File action throughout the document tree and command palette so any document can be exported with a context-aware filename and extension.
18-
19-
### 📝 Documentation
20-
21-
- Documented the export workflow across the README and manuals, including technical notes about the new `documentExportService` and how the Electron bridge streams files to disk.
24+
- _No entries yet._
2225

2326
## v0.6.8 - The Shortcut & Clipboard Update
2427

@@ -53,11 +56,6 @@
5356
- Integrated GitHub Spec Kit workflows and refreshed assets so future changes
5457
arrive with automated specification checks.
5558

56-
> TODO: Document how to clear or reset keyboard shortcuts in the Functional
57-
> Manual's settings chapter.
58-
> TODO: Call out PlantUML and TOML syntax coverage in the published manuals so
59-
> users can discover the new language support.
60-
6159
## v0.6.7 - The Auto-Update Reliability Pass
6260

6361
### ✨ Features

0 commit comments

Comments
 (0)