From f4c8ef3e6df4fc51c6646ebda679b17cac7fdccc Mon Sep 17 00:00:00 2001 From: forkless Date: Tue, 2 Jun 2026 17:57:01 +0200 Subject: [PATCH] move KNOWN_ISSUES.md to root, reflect v0.3.0 privacy changes --- CHANGELOG.md | 2 ++ KNOWN_ISSUES.md | 24 ++++++++++++++++++++++++ docs/KNOWN_ISSUES.md | 13 ------------- 3 files changed, 26 insertions(+), 13 deletions(-) create mode 100644 KNOWN_ISSUES.md delete mode 100644 docs/KNOWN_ISSUES.md diff --git a/CHANGELOG.md b/CHANGELOG.md index 8368e08..52b3878 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -52,6 +52,8 @@ All notable changes to NotAlterra are documented in this file. - **Zero clippy warnings on CI** — fixed `collapsible_match` (6 instances), `empty_line_after_doc_comments`, and `manual_is_multiple_of` lints from rustc 1.95 nightly. +- **`KNOWN_ISSUES.md` moved from `docs/` to project root** — reflects v0.3.0 + privacy improvements (manual path entry live, discovery deprecated). ### Notes - Working copy diverged from remote after signing the previous commit diff --git a/KNOWN_ISSUES.md b/KNOWN_ISSUES.md new file mode 100644 index 0000000..175e06b --- /dev/null +++ b/KNOWN_ISSUES.md @@ -0,0 +1,24 @@ +# Known Issues + +## config.ini persists the save path + +`config.ini` caches the save-folder path on disk next to the binary. Paths are +sanitized in transaction logs, but the raw path remains in the config file for +re-use across sessions. + +The recommended workflow now uses **Set save folder** from the main menu to +enter paths manually. Delete `config.ini` to clear the cached path — the app +will prompt you to set a new one on next launch. + +**Planned**: Remove `config.ini` entirely in a future release. The path would +be re-requested from the user on each session. v0.4.0 target. + +## Discovery module is deprecated + +Auto-scan for save folders (`discovery.rs`) is deprecated in favor of the +**Set save folder** menu option. The `Locate save files` item shows a +deprecation notice once per session. Scanning user profiles and system +directories is a privacy concern and this module is scheduled for removal. + +**Planned**: Remove `discovery.rs` entirely in v0.4.0. Users will enter their +save path manually via `Set save folder`. diff --git a/docs/KNOWN_ISSUES.md b/docs/KNOWN_ISSUES.md deleted file mode 100644 index d4cd7c1..0000000 --- a/docs/KNOWN_ISSUES.md +++ /dev/null @@ -1,13 +0,0 @@ -# Known Issues - -## config.ini persists the save path - -`config.ini` caches the save-folder path on disk (next to the binary). Paths are sanitized in transaction logs, but the raw path remains in the config file for re-use across sessions. - -**Planned**: Remove `config.ini` entirely in a future release. The path would be re-requested from the user on each session. v0.3.0 target. - -## Discovery module is deprecated - -Auto-scan for save folders (`discovery.rs`) is deprecated — it scans user profiles and system directories for Subnautica 2 saves, which is a privacy concern. The `Locate save files` menu item shows a deprecation notice once per session. - -**Planned**: Remove `discovery.rs` entirely in v0.3.0. Users will enter their save path manually via `Set save folder`.