docs: fix README links to untracked directories and correct an example command - #3
Open
egeboy35 wants to merge 1 commit into
Open
docs: fix README links to untracked directories and correct an example command#3egeboy35 wants to merge 1 commit into
egeboy35 wants to merge 1 commit into
Conversation
… CLI flag The root README linked to several files under newsdr/ and docs/ that are not tracked in the repository (both directories are listed in .gitignore), so the links render as 404s on GitHub. It also showed "python sdradi/sdr_auto_tune.py --mode rx", but that script's argparse only defines --ip, so the documented command exits with an error. This change keeps all of the original sections and wording, and only: - converts the dead newsdr/ and docs/ links to inline code, with a short italic note that those directories are not currently tracked; - replaces the sdr_auto_tune.py example with a minimal valid invocation (no flags; --ip mentioned as the optional device selector). Verification: every remaining markdown link target and command path in README.md was checked against git ls-files; all 57 in-repo references now resolve, and sdradi/sdr_video_commv2_lab.py --mode loopback was confirmed valid against its argparse (choices include "loopback"). Co-Authored-By: Claude Fable 5 <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.
Hi, thank you for maintaining this project — the README is a great overview of the monorepo. While following it on a fresh clone I ran into a few small accuracy issues and would like to propose fixes. This PR only touches the root README.md.
Problem
newsdr/anddocs/(the newsdr section's five scripts and five technique documents,docs/plutosdr_setup_guide.md,docs/sdr_radios.md, and one Documentation Index entry). Both directories are listed in.gitignore, so they are not present in a fresh clone and the links show 404 on GitHub.python sdradi/sdr_auto_tune.py --mode rxdoes not match the script's CLI:sdradi/sdr_auto_tune.pydefines only--ip(defaultip:192.168.3.2), so the documented command exits withunrecognized arguments.Fix
python sdradi/sdr_auto_tune.pyand mentioned--ipas the optional device selector.Verification
git ls-files: all in-repo references now resolve to tracked files.sdr_video_commv2_lab.py --mode loopbackis valid;radarappwdevice5.pyneeds no required arguments), and that the referenced diagnostic scripts and configs all exist.Please let me know if you would prefer different phrasing for the notes, or if the
newsdr//docs/content is meant to be tracked — glad to rework this accordingly.🤖 Generated with Claude Code