Skip to content

Commit 87256f2

Browse files
authored
Merge pull request #220 from beNative/codex/prepare-release-for-github-publishing
Prepare v0.7.0 release documentation
2 parents 172e923 + 206a7a9 commit 87256f2

12 files changed

Lines changed: 115 additions & 32 deletions

FUNCTIONAL_MANUAL.md

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -16,6 +16,7 @@ The top-most bar of the application provides global controls and information.
1616
- **Command Palette Search:** The central search box is your primary way to access the **Command Palette**. Clicking it or using the `Ctrl+Shift+P` shortcut opens a dropdown list of all available actions.
1717
- **Global Actions (Right Side):**
1818
- **Info:** Toggles the Info View, where you can read application documentation.
19+
- **About:** Opens the About DocForge modal with project links and an "Open installation folder" button that jumps straight to the directory containing the running executable.
1920
- **Logs:** Toggles the Logger Panel at the bottom of the screen.
2021
- **Theme Toggle:** Switches the application between light and dark modes.
2122
- **Settings:** Toggles the Settings View.
@@ -76,6 +77,7 @@ The bar at the bottom of the window provides at-a-glance information about the a
7677
- **LLM Connection Status:** A colored dot (green for connected, red for error) and text indicating the connection status to your local AI provider.
7778
- **Provider & Model Selection:** Dropdown menus to see the currently configured LLM provider and model, and to quickly switch between other detected services and their available models.
7879
- **Statistics:** Shows the total number of documents and the last save time for the active document.
80+
- **Workspace Zoom:** A single cluster of zoom buttons, percentage readout, and reset control that automatically targets the preview or editor depending on which pane has focus. Zoom adjustments now move in 5% increments for precise scaling.
7981
- **App Version:** Displays the current version of DocForge.
8082

8183
---
@@ -86,7 +88,7 @@ The bar at the bottom of the window provides at-a-glance information about the a
8688

8789
- **New Document:** Click the `+` icon at the top of the sidebar or use the `Ctrl+N` shortcut. New documents default to Markdown.
8890
- **New Code File:** Click the code icon. A dialog will appear asking you to provide a filename with an extension (e.g., `script.js`) for automatic language detection.
89-
- **New from Clipboard:** Use the command palette entry or sidebar menu item to create a document from the current clipboard contents. DocForge will import the text verbatim, detect the document type automatically, and report the classification in the activity log. If clipboard access is denied, the app shows guidance for restoring permissions.
91+
- **New from Clipboard:** Use the command palette entry or sidebar menu item to create a document from the current clipboard contents. DocForge will import the text verbatim, detect the document type automatically, generate a title with your connected LLM when it's online, and report the classification in the activity log. If clipboard access is denied, the app shows guidance for restoring permissions.
9092
- **New Root Folder:** Click the folder icon with a `+` to create a new folder at the root of your document list.
9193
- **New Subfolder:** Select an existing folder and click the "New Subfolder" icon to create a folder inside it.
9294
- **Duplicate Selection:** Select one or more items and click the "Duplicate" icon to create a deep copy.
@@ -231,4 +233,5 @@ Accessed via the terminal icon in the title bar, this panel is your primary tool
231233
- **Integrated Layout:** The panel is part of the main application layout. When opened, it pushes the content above it upwards, rather than covering it. This ensures the main screen remains fully interactive. The panel's height is resizable by dragging its top border.
232234
- **Action Logging:** The logger automatically records every significant action you take in the application, such as creating a document, changing a setting, or using a command. This provides a clear history of operations.
233235
- **Filtering:** You can filter logs by level (DEBUG, INFO, WARNING, ERROR).
236+
- **Selection & Copy Tools:** Click, Shift-click, or drag with modifier keys to select individual log entries or ranges. Use the Copy Selected button to export the chosen entries with configurable toggles for timestamps, log levels, and line breaks.
234237
- **Actions:** You can clear the logs or save the current session's log to a file.

README.md

Lines changed: 6 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -7,14 +7,15 @@ DocForge is a desktop application designed to streamline the process of creating
77
- **Modern, Draggable Title Bar:** A sleek, VS Code-style custom title bar maximizes screen space and integrates essential functions (Electron version only).
88
- **Integrated Command Palette:** Quickly access all core functions from a central search bar.
99
- **Hierarchical Document Organization:** Organize your documents in a familiar folder structure. Create nested subfolders, duplicate items, and use drag-and-drop to rearrange your workspace or import files from your computer.
10-
- **Clipboard Capture:** Turn whatever is on your system clipboard into a document in one step—DocForge classifies the contents automatically and prompts you to restore permissions if clipboard access is blocked.
10+
- **Clipboard Capture:** Turn whatever is on your system clipboard into a document in one step—DocForge classifies the contents automatically, generates a title with your connected LLM when possible, and prompts you to restore permissions if clipboard access is blocked.
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.
1414
- **Cancel Unsaved Changes:** Instantly roll a document back to its last saved state with a dedicated toolbar button when an experiment goes sideways.
1515
- **Document Locking:** Protect sensitive drafts by toggling a padlock button that flips the editor into a read-only mode until you intentionally unlock it.
1616
- **Multi-Document Tabs:** Keep several documents open at once, pin important files, and quickly jump between them using the tab strip and overflow picker.
1717
- **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.
18+
- **Focused Workspace Zoom:** Use a single set of zoom controls that automatically follow whichever pane—editor or preview—has focus, complete with 5% increments, keyboard and mouse support, and quick resets.
1819
- **AI-Powered Refinement:** Use your connected local LLM to automatically refine and improve your documents with a single click.
1920
- **Document Templating:** Create reusable document templates with variables to quickly generate new documents for recurring tasks.
2021
- **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.
@@ -29,7 +30,7 @@ DocForge is a desktop application designed to streamline the process of creating
2930
- **Database Management:** A dedicated settings panel allows you to view database statistics, run integrity checks, and perform maintenance like backups and optimization.
3031
- **Workspace Bootstrap:** Create a brand new SQLite database from the status bar or settings to start fresh without leaving the app.
3132
- **Configurable Data Storage:** Choose a custom SQLite database location or reopen an existing workspace file from the settings panel.
32-
- **Comprehensive Action Logging**: Every user action is logged, providing a clear audit trail and making debugging easier.
33+
- **Comprehensive Action Logging**: Every user action is logged, and the logger panel now supports range selections, modifier-aware drag selection, and configurable copy-to-clipboard exports with or without timestamps and levels.
3334
- **Offline First:** All your data is stored locally on your machine.
3435
- **Auto-Update:** Control automatic startup checks, opt into pre-release builds, and trigger manual "Check for Updates" scans that report success or errors inline.
3536
- **Resizable Layout:** The sidebar, templates panel, and logger panel are all fully resizable to customize your workspace.
@@ -42,7 +43,7 @@ DocForge is a desktop application designed to streamline the process of creating
4243
4. **Create:** Start creating, organizing, and refining your documents!
4344

4445
For detailed instructions on usage and features, please refer to the [Functional Manual](./FUNCTIONAL_MANUAL.md).
45-
To review the history of changes, see the [Version Log](./VERSION_LOG.md).
46+
To review the history of changes, see the [Version Log](./VERSION_LOG.md). Detailed release notes are archived under [`docs/releases/`](./docs/releases).
4647

4748
## Spec-Driven Development Workflow
4849

@@ -86,11 +87,11 @@ Run `specify check` inside the repository to confirm prerequisites.
8687
To create a new public build of DocForge:
8788

8889
1. Update the version in `package.json` and regenerate the lockfile with `npm version <new-version> --no-git-tag-version`.
89-
2. Draft the release notes by updating `VERSION_LOG.md` with a new section that summarizes the changes included in the release (the automated workflow copies the top entry into the GitHub release body).
90+
2. Draft the release notes by updating `VERSION_LOG.md` with a new section that summarizes the changes included in the release (the automated workflow copies the top entry into the GitHub release body) and by capturing detailed notes under `docs/releases/<version>.md` for archival.
9091
3. Review the Markdown documentation (README, manuals, and release notes) so the written guidance matches the current workflow.
9192
4. Sync the documentation copies under `docs/` (README, manuals, version log) with any updates made at the project root.
9293
5. Commit the changes and push them to the default branch so the release tag points at the finalized documentation.
93-
6. Create and push a tag that matches the new version (for example, `git tag v0.6.10` followed by `git push origin v0.6.10`) to trigger the automated release workflow.
94+
6. Create and push a tag that matches the new version (for example, `git tag v0.7.0` followed by `git push origin v0.7.0`) to trigger the automated release workflow.
9495
7. Monitor the "Release" workflow run, then confirm that the published GitHub release lists the correct notes and includes installers for every platform before announcing availability.
9596

9697
## Application Icon Workflow

TECHNICAL_MANUAL.md

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -59,6 +59,7 @@ The main process is responsible for managing the application lifecycle, database
5959
- `db:duplicate-nodes`: A handler to perform a deep, transactional copy of selected nodes.
6060
- `db:migrate-from-json`: A special handler for the one-time migration of data from old JSON files.
6161
- Window Controls: Handlers for `window:minimize`, `window:maximize`, etc.
62+
- Application Integrations: `app:open-executable-folder` resolves the on-disk location of the running binary and opens it via the host OS shell so support teams can quickly reach the installation directory.
6263
- **Security:** The `preload.ts` script uses Electron's `contextBridge` to securely expose specific IPC functions to the renderer process under the `window.electronAPI` object, maintaining context isolation.
6364

6465
### Renderer Process (React)
@@ -119,6 +120,7 @@ DocForge treats shell and PowerShell automation as first-class workflows that sp
119120
This module handles all communication with the external Large Language Model. It is largely unchanged by the database migration.
120121
- It constructs the appropriate API request body based on the configured API type (Ollama or OpenAI-compatible).
121122
- It includes robust error handling to manage connection failures or non-OK responses from the provider.
123+
- Clipboard imports invoke `llmService.generateTitle()` when a provider is online, allowing the renderer to assign meaningful titles to new documents automatically.
122124

123125
### Component Breakdown
124126

@@ -141,11 +143,11 @@ Electron Builder manages the packaging and publishing workflow for DocForge. The
141143
### Publishing a Release
142144

143145
1. Run `npm version <new-version> --no-git-tag-version` to bump the version in both `package.json` and `package-lock.json` without creating a Git tag.
144-
2. Update `VERSION_LOG.md` with a new section that captures the highlights of the release—the automated workflow copies the top entry into the GitHub release body.
146+
2. Update `VERSION_LOG.md` with a new section that captures the highlights of the release—the automated workflow copies the top entry into the GitHub release body—and record detailed notes under `docs/releases/<version>.md` for long-form context.
145147
3. Review and update the Markdown documentation (README, manuals, release notes) so the written guidance reflects the final state of the build.
146148
4. Sync the Markdown files under `docs/` with the copies at the project root.
147149
5. Commit and push the changes so the release tag points at the finished documentation.
148-
6. Create and push a matching version tag (for example, `git tag v0.6.10` followed by `git push origin v0.6.10`) to trigger the automated release pipeline.
150+
6. Create and push a matching version tag (for example, `git tag v0.7.0` followed by `git push origin v0.7.0`) to trigger the automated release pipeline.
149151
7. Monitor the "Release" workflow run and verify the published GitHub release lists the correct notes and includes the installers for every supported platform before announcing availability.
150152

151153
### Automated Release Workflow

VERSION_LOG.md

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,26 @@
11
# Version Log
22

3+
## v0.7.0 - The Focused Zoom & Clipboard Intelligence Update
4+
5+
### ✨ Features
6+
7+
- Automatically generate titles for clipboard imports whenever a local LLM is connected, so captured snippets arrive with meaningful names without extra typing. [#218](https://github.com/beNative/docforge/pull/218)
8+
- Added an "Open installation folder" action to the About dialog via a new Electron bridge, making it easy to locate the running binaries during support sessions. [#216](https://github.com/beNative/docforge/pull/216)
9+
10+
### 🛠 Improvements
11+
12+
- Gave the workspace zoom controls their own focus target so buttons, shortcuts, and 5% increments follow whichever pane (editor or preview) you're working in, and clarified the status bar label. [#217](https://github.com/beNative/docforge/pull/217)
13+
- Expanded the logger panel with range selection, drag multi-select, and configurable clipboard exports for timestamps, levels, and line breaks. [#215](https://github.com/beNative/docforge/pull/215)
14+
- Matched the Folder Overview rename button styling to its neighboring controls for a consistent affordance. [#214](https://github.com/beNative/docforge/pull/214)
15+
16+
### 🐛 Fixes
17+
18+
- Restored the default tooltip styling for truncated sidebar titles so hover hints stay legible. [#219](https://github.com/beNative/docforge/pull/219)
19+
20+
### 📝 Documentation
21+
22+
- Documented the focused zoom workflow, clipboard title generation, logger export tools, and the new About dialog shortcut while preparing the v0.7.0 release package.
23+
324
## v0.6.10 - The Auto-Install Controls Update
425

526
### ✨ Features

docs/FUNCTIONAL_MANUAL.md

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -16,6 +16,7 @@ The top-most bar of the application provides global controls and information.
1616
- **Command Palette Search:** The central search box is your primary way to access the **Command Palette**. Clicking it or using the `Ctrl+Shift+P` shortcut opens a dropdown list of all available actions.
1717
- **Global Actions (Right Side):**
1818
- **Info:** Toggles the Info View, where you can read application documentation.
19+
- **About:** Opens the About DocForge modal with project links and an "Open installation folder" button that jumps straight to the directory containing the running executable.
1920
- **Logs:** Toggles the Logger Panel at the bottom of the screen.
2021
- **Theme Toggle:** Switches the application between light and dark modes.
2122
- **Settings:** Toggles the Settings View.
@@ -76,6 +77,7 @@ The bar at the bottom of the window provides at-a-glance information about the a
7677
- **LLM Connection Status:** A colored dot (green for connected, red for error) and text indicating the connection status to your local AI provider.
7778
- **Provider & Model Selection:** Dropdown menus to see the currently configured LLM provider and model, and to quickly switch between other detected services and their available models.
7879
- **Statistics:** Shows the total number of documents and the last save time for the active document.
80+
- **Workspace Zoom:** A single cluster of zoom buttons, percentage readout, and reset control that automatically targets the preview or editor depending on which pane has focus. Zoom adjustments now move in 5% increments for precise scaling.
7981
- **App Version:** Displays the current version of DocForge.
8082

8183
---
@@ -86,7 +88,7 @@ The bar at the bottom of the window provides at-a-glance information about the a
8688

8789
- **New Document:** Click the `+` icon at the top of the sidebar or use the `Ctrl+N` shortcut. New documents default to Markdown.
8890
- **New Code File:** Click the code icon. A dialog will appear asking you to provide a filename with an extension (e.g., `script.js`) for automatic language detection.
89-
- **New from Clipboard:** Use the command palette entry or sidebar menu item to create a document from the current clipboard contents. DocForge will import the text verbatim, detect the document type automatically, and report the classification in the activity log. If clipboard access is denied, the app shows guidance for restoring permissions.
91+
- **New from Clipboard:** Use the command palette entry or sidebar menu item to create a document from the current clipboard contents. DocForge will import the text verbatim, detect the document type automatically, generate a title with your connected LLM when it's online, and report the classification in the activity log. If clipboard access is denied, the app shows guidance for restoring permissions.
9092
- **New Root Folder:** Click the folder icon with a `+` to create a new folder at the root of your document list.
9193
- **New Subfolder:** Select an existing folder and click the "New Subfolder" icon to create a folder inside it.
9294
- **Duplicate Selection:** Select one or more items and click the "Duplicate" icon to create a deep copy.
@@ -231,4 +233,5 @@ Accessed via the terminal icon in the title bar, this panel is your primary tool
231233
- **Integrated Layout:** The panel is part of the main application layout. When opened, it pushes the content above it upwards, rather than covering it. This ensures the main screen remains fully interactive. The panel's height is resizable by dragging its top border.
232234
- **Action Logging:** The logger automatically records every significant action you take in the application, such as creating a document, changing a setting, or using a command. This provides a clear history of operations.
233235
- **Filtering:** You can filter logs by level (DEBUG, INFO, WARNING, ERROR).
236+
- **Selection & Copy Tools:** Click, Shift-click, or drag with modifier keys to select individual log entries or ranges. Use the Copy Selected button to export the chosen entries with configurable toggles for timestamps, log levels, and line breaks.
234237
- **Actions:** You can clear the logs or save the current session's log to a file.

0 commit comments

Comments
 (0)