chore: relocate planning docs + reference fixtures from docs/ (#2933, PR 8)#2953
Merged
Conversation
… PR 8) Eight docs leave the top-level docs/ tree, partitioned by purpose: docs/archive/ — historical planning/session notes, kept for grep context: - issue-2136-feasibility-report.md (PR #2759, shipped) - issue-2136-implementation-plan.md (PR #2759, shipped) - TX_SYNC_FIX_REPORT.md (PR #353, RadioModel.cpp still references the report by name) - aether-dsp-session-notes.md (#796 maintainer notebook) docs/data/ — reference fixtures (not bundled, not runtime): - SSDR.settings + SmartSDR.exe.config (SmartSDR parity reference) - rxapplet_mode_settings.csv (per-mode RX control research) - vfo_mode_filters.csv (VFO filter-preset research; VfoWidget.cpp comment updated to new path) Kept in docs/ (still active): - audio_test_plan.md (17 KB, edited 2026-04-29, ongoing test plan) - profile-import-export-manual-checklist.md (PR #2641 QA checklist) Both new dirs include a one-paragraph README explaining the convention so a future maintainer doesn't have to guess what belongs where. Cross-references audited: - AppSettings.h:9 mentions "SmartSDR's SSDR.settings" as a concept, not a path — no change. - RadioModel.cpp:3991 references TX_SYNC_FIX_REPORT by name — no change, file is findable via grep/find. - VfoWidget.cpp:3324 carried a literal "docs/vfo_mode_filters.csv" path — updated to docs/data/. Verified with a clean local Release build (cmake --build … --target AetherSDR exits 0). After this PR, docs/ contains 18 markdown files (architecture/user docs), the assets/ subdir from PR 5, and the new archive/ + data/ subdirs — matches the acceptance criteria in the cleanup plan. Principle I. Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
Contributor
There was a problem hiding this comment.
Looks good — thanks @ten9876.
Verified locally:
git grepfor the olddocs/{SSDR.settings,SmartSDR.exe.config,*.csv,TX_SYNC_FIX_REPORT,aether-dsp-session-notes,issue-2136-*}paths returns no hits after this PR. The lone literal-path reference (src/gui/VfoWidget.cpp:3324) is updated todocs/data/vfo_mode_filters.csv.src/core/AppSettings.h:9referencesSSDR.settingsby concept only (no path), so leaving it untouched is correct.src/models/RadioModel.cpp:3991referencesTX_SYNC_FIX_REPORTby name only — still findable via grep underdocs/archive/.
Mechanical move of doc/fixture files, no runtime impact, and the two new README files do a nice job of explaining what belongs where so this scheme doesn't quietly rot. No concerns from a conventions / RAII / error-handling angle — there's no code logic in here to evaluate.
Nit (non-blocking, do not need to address): the two new READMEs are missing a trailing newline. Some editors and git diff --check flag this; harmless either way.
G6PWY-Chris
pushed a commit
to G6PWY-Chris/AetherSDR
that referenced
this pull request
Jun 22, 2026
…sdr#2933, PR 8) (aethersdr#2953) Eight docs leave the top-level docs/ tree, partitioned by purpose: docs/archive/ — historical planning/session notes, kept for grep context: - issue-2136-feasibility-report.md (PR aethersdr#2759, shipped) - issue-2136-implementation-plan.md (PR aethersdr#2759, shipped) - TX_SYNC_FIX_REPORT.md (PR aethersdr#353, RadioModel.cpp still references the report by name) - aether-dsp-session-notes.md (aethersdr#796 maintainer notebook) docs/data/ — reference fixtures (not bundled, not runtime): - SSDR.settings + SmartSDR.exe.config (SmartSDR parity reference) - rxapplet_mode_settings.csv (per-mode RX control research) - vfo_mode_filters.csv (VFO filter-preset research; VfoWidget.cpp comment updated to new path) Kept in docs/ (still active): - audio_test_plan.md (17 KB, edited 2026-04-29, ongoing test plan) - profile-import-export-manual-checklist.md (PR aethersdr#2641 QA checklist) Both new dirs include a one-paragraph README explaining the convention so a future maintainer doesn't have to guess what belongs where. Cross-references audited: - AppSettings.h:9 mentions "SmartSDR's SSDR.settings" as a concept, not a path — no change. - RadioModel.cpp:3991 references TX_SYNC_FIX_REPORT by name — no change, file is findable via grep/find. - VfoWidget.cpp:3324 carried a literal "docs/vfo_mode_filters.csv" path — updated to docs/data/. Verified with a clean local Release build (cmake --build … --target AetherSDR exits 0). After this PR, docs/ contains 18 markdown files (architecture/user docs), the assets/ subdir from PR 5, and the new archive/ + data/ subdirs — matches the acceptance criteria in the cleanup plan. Principle I. Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com> Co-authored-by: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Eight docs leave the top-level docs/ tree, partitioned by purpose:
docs/archive/ — historical planning/session notes, kept for grep context:
references the report by name)
docs/data/ — reference fixtures (not bundled, not runtime):
VfoWidget.cpp comment updated to new path)
Kept in docs/ (still active):
Both new dirs include a one-paragraph README explaining the convention
so a future maintainer doesn't have to guess what belongs where.
Cross-references audited:
not a path — no change.
change, file is findable via grep/find.
path — updated to docs/data/.
Verified with a clean local Release build (cmake --build … --target
AetherSDR exits 0).
After this PR, docs/ contains 18 markdown files (architecture/user
docs), the assets/ subdir from PR 5, and the new archive/ + data/
subdirs — matches the acceptance criteria in the cleanup plan.
Principle I.
Co-Authored-By: Claude Opus 4.7 (1M context) noreply@anthropic.com