Skip to content

Commit 65e417d

Browse files
authored
Merge pull request #213 from beNative/codex/prepare-github-release-and-update-documentation
Prepare v0.6.10 release
2 parents 656c09a + 56a6d07 commit 65e417d

File tree

11 files changed

+53
-22
lines changed

11 files changed

+53
-22
lines changed

FUNCTIONAL_MANUAL.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -203,7 +203,7 @@ Accessed via the gear icon in the title bar. The settings are organized into cat
203203
- **LLM Provider:** Configure your connection to a local AI service. You can detect running services and select a model.
204204
- **Appearance:** Change the UI scale and choose from different icon sets.
205205
- **Keyboard Shortcuts:** View and customize keyboard shortcuts for all major application actions. You can record a new key combination for any command.
206-
- **General:** Configure application behavior, like auto-saving logs, opting into pre-release updates, and choosing how PlantUML diagrams are rendered. This section includes an **Automatic Update Checks** toggle that determines whether DocForge contacts the update service on launch, a **Pre-release Updates** toggle that opts into beta builds, and a **Check for Updates** button for running a manual scan on demand. Manual checks report their status inline—showing a spinner and "Checking…" label during the request, a success message when you're current or when a download starts, and an error message with troubleshooting details if the update service is unreachable or disabled in the web preview.
206+
- **General:** Configure application behavior, like auto-saving logs, opting into pre-release updates, and choosing how PlantUML diagrams are rendered. This section includes an **Automatic Update Checks** toggle that determines whether DocForge contacts the update service on launch, an **Automatic Installation** toggle that decides if downloaded updates install themselves the next time you quit, a **Pre-release Updates** toggle that opts into beta builds, and a **Check for Updates** button for running a manual scan on demand. Manual checks report their status inline—showing a spinner and "Checking…" label during the request, a success message when you're current or when a download starts, and an error message with troubleshooting details if the update service is unreachable or disabled in the web preview. When an update finishes downloading, DocForge surfaces a toast with progress details, a **Restart & Install** button, and the same automatic-install switch (desktop builds only) so you can adjust your preference without opening Settings.
207207
- **Python:** Choose the interpreter used by the integrated runner. DocForge auto-detects local interpreters, can bootstrap a dedicated virtual environment per workspace, and exposes console preferences such as default working directory, automatic history retention, and whether runs open in split view.
208208
- **Shell & PowerShell:** Define default environment variables, working directories, and interpreter overrides for each scripting language. Document-specific panels start with these defaults and can layer additional overrides without mutating the workspace baseline.
209209
- **Database:** View detailed statistics about your local database file, and perform maintenance tasks such as creating a compressed backup, checking file integrity, optimizing the database size (`VACUUM`), or bootstrapping a brand new workspace database.

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -90,7 +90,7 @@ To create a new public build of DocForge:
9090
3. Review the Markdown documentation (README, manuals, and release notes) so the written guidance matches the current workflow.
9191
4. Sync the documentation copies under `docs/` (README, manuals, version log) with any updates made at the project root.
9292
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.9` followed by `git push origin v0.6.9`) to trigger the automated release workflow.
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.
9494
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.
9595

9696
## Application Icon Workflow

TECHNICAL_MANUAL.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -145,7 +145,7 @@ Electron Builder manages the packaging and publishing workflow for DocForge. The
145145
3. Review and update the Markdown documentation (README, manuals, release notes) so the written guidance reflects the final state of the build.
146146
4. Sync the Markdown files under `docs/` with the copies at the project root.
147147
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.9` followed by `git push origin v0.6.9`) to trigger the automated release pipeline.
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.
149149
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.
150150

151151
### Automated Release Workflow

VERSION_LOG.md

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,23 @@
11
# Version Log
22

3+
## v0.6.10 - The Auto-Install Controls Update
4+
5+
### ✨ Features
6+
7+
- Added an **Automatic Installation** toggle to Settings → General so administrators can decide whether DocForge installs downloaded updates the next time they quit.
8+
- Mirrored the automatic-install switch inside the in-app update toast (desktop builds) alongside progress indicators and restart controls, letting you adjust the preference without leaving your workflow.
9+
10+
### 🐛 Fixes
11+
12+
- Ensured the desktop updater honors the saved automatic-install preference across sessions so downloads no longer revert to installing on quit unexpectedly.
13+
14+
### 📝 Documentation
15+
16+
- Documented the automatic-install controls and refreshed the release guides for the v0.6.10 tagging workflow.
17+
318
## v0.6.9 - The Workflow & Execution Update
419

20+
521
### ✨ Features
622

723
- 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.

docs/FUNCTIONAL_MANUAL.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -203,7 +203,7 @@ Accessed via the gear icon in the title bar. The settings are organized into cat
203203
- **LLM Provider:** Configure your connection to a local AI service. You can detect running services and select a model.
204204
- **Appearance:** Change the UI scale and choose from different icon sets.
205205
- **Keyboard Shortcuts:** View and customize keyboard shortcuts for all major application actions. You can record a new key combination for any command.
206-
- **General:** Configure application behavior, like auto-saving logs, opting into pre-release updates, and choosing how PlantUML diagrams are rendered. This section includes an **Automatic Update Checks** toggle that determines whether DocForge contacts the update service on launch, a **Pre-release Updates** toggle that opts into beta builds, and a **Check for Updates** button for running a manual scan on demand. Manual checks report their status inline—showing a spinner and "Checking…" label during the request, a success message when you're current or when a download starts, and an error message with troubleshooting details if the update service is unreachable or disabled in the web preview.
206+
- **General:** Configure application behavior, like auto-saving logs, opting into pre-release updates, and choosing how PlantUML diagrams are rendered. This section includes an **Automatic Update Checks** toggle that determines whether DocForge contacts the update service on launch, an **Automatic Installation** toggle that decides if downloaded updates install themselves the next time you quit, a **Pre-release Updates** toggle that opts into beta builds, and a **Check for Updates** button for running a manual scan on demand. Manual checks report their status inline—showing a spinner and "Checking…" label during the request, a success message when you're current or when a download starts, and an error message with troubleshooting details if the update service is unreachable or disabled in the web preview. When an update finishes downloading, DocForge surfaces a toast with progress details, a **Restart & Install** button, and the same automatic-install switch (desktop builds only) so you can adjust your preference without opening Settings.
207207
- **Python:** Choose the interpreter used by the integrated runner. DocForge auto-detects local interpreters, can bootstrap a dedicated virtual environment per workspace, and exposes console preferences such as default working directory, automatic history retention, and whether runs open in split view.
208208
- **Shell & PowerShell:** Define default environment variables, working directories, and interpreter overrides for each scripting language. Document-specific panels start with these defaults and can layer additional overrides without mutating the workspace baseline.
209209
- **Database:** View detailed statistics about your local database file, and perform maintenance tasks such as creating a compressed backup, checking file integrity, optimizing the database size (`VACUUM`), or bootstrapping a brand new workspace database.

docs/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -88,7 +88,7 @@ To create a new public build of DocForge:
8888
3. Review the Markdown documentation (README, manuals, and release notes) so the written guidance matches the current workflow.
8989
4. Sync the documentation copies under `docs/` (README, manuals, version log) with any updates made at the project root.
9090
5. Commit the changes and push them to the default branch so the release tag points at the finalized documentation.
91-
6. Create and push a tag that matches the new version (for example, `git tag v0.6.9` followed by `git push origin v0.6.9`) to trigger the automated release workflow.
91+
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.
9292
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.
9393

9494
## Application Icon Workflow

docs/TECHNICAL_MANUAL.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -145,7 +145,7 @@ Electron Builder manages the packaging and publishing workflow for DocForge. The
145145
3. Review and update the Markdown documentation (README, manuals, release notes) so the written guidance reflects the final state of the build.
146146
4. Sync the Markdown files under `docs/` with the copies at the project root.
147147
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.9` followed by `git push origin v0.6.9`) to trigger the automated release pipeline.
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.
149149
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.
150150

151151
### Automated Release Workflow

docs/VERSION_LOG.md

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

3+
## v0.6.10 - The Auto-Install Controls Update
4+
5+
### ✨ Features
6+
7+
- Added an **Automatic Installation** toggle to Settings → General so administrators can decide whether DocForge installs downloaded updates the next time they quit.
8+
- Mirrored the automatic-install switch inside the in-app update toast (desktop builds) alongside progress indicators and restart controls, letting you adjust the preference without leaving your workflow.
9+
10+
### 🐛 Fixes
11+
12+
- Ensured the desktop updater honors the saved automatic-install preference across sessions so downloads no longer revert to installing on quit unexpectedly.
13+
14+
### 📝 Documentation
15+
16+
- Documented the automatic-install controls and refreshed the release guides for the v0.6.10 tagging workflow.
17+
318
## v0.6.9 - The Workflow & Execution Update
419

520
### ✨ Features

package-lock.json

Lines changed: 2 additions & 2 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
{
22
"name": "docforge",
3-
"version": "0.6.9",
3+
"version": "0.6.10",
44
"description": "An application to manage and refine documents.",
55
"main": "dist/main.js",
66
"scripts": {

0 commit comments

Comments
 (0)