Documentation refresh: align first-read docs with what shipped in PR #6#7
Merged
Conversation
PR #6 grew through several rounds of fixes and the surrounding docs ended up out of date. This pass walks every doc file and brings it back in line with what actually ships: README.md - Drop the "pre-alpha" / "-DWITH_RX888=ON gates a silent block" paragraph; v0.2 is in. - rx888-tools link points at ringof/, not ka9q/. - Block parameter table: samprate default 32e6 (was 64.8e6). - Stream tags / status messages are clearly marked as planned for a follow-up, not currently emitted. - grc-demo entrypoint description matches reality (AM BCB audio flowgraph + PulseAudio passthrough, not the old hf_waterfall + --device /dev/snd). - Status section reflects v0.1/v0.2 shipped + v0.3 in flight. examples/README.md - am_bcb_audio_demo block diagram now includes the chan_decim=10 stage we added; audio_decim is 4 (not the stale 40). - audio.sink note describes the ALSA-pulse-plugin routing through the host's PulseAudio, not --device /dev/snd. MANIFEST.md - Real author / copyright / license / repo / tags instead of the gr_modtool template placeholders. docs/PLAN.md - Live status snapshot at the top: librx888 shipped, gr-rx888 v0.2 shipped, sanitizers green, what's next. Original plan body preserved unchanged. docs/README.rx888 - Was a gr_modtool template that imported `rx888` instead of `gnuradio.rx888`. Replaced with a brief, correct C++/Python import recipe and a pointer to the example flowgraphs. docker/grc-demo.sh - Header comment updated: PulseAudio socket bind-mount is the audio recipe now, --device /dev/snd was the failed prior path. include/gnuradio/rx888/source.h - Doxygen example for `samprate` shows 32e6 / 135e6 (the firmware-supported values), not 64.8e6. tests/mock/CMakeLists.txt - LIBRX888_INCLUDE_DIRS dropped the stale ${CMAKE_SOURCE_DIR}/tests/librx888 entry (that dir was deleted when librx888 went upstream). No code behavior changes. Verified locally with -DWITH_RX888_MOCK=ON build + ctest — both qa_source and qa_source_mock pass.
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
2 participants
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.
Summary
Documentation audit after the PR #6 chain (librx888 ABI sync, AM BCB audio demo, PulseAudio routing). The code shipped but the docs drifted through several rounds of fixes — this PR brings every first-read doc file back in line with what actually exists in
main.Stale claims fixed
README.md-DWITH_RX888=ON(option gone);ka9q/rx888-tools(wrong org);samprate=64.8e6default; stream tags + status messages described as shipped (they're not yet); grc-demo "HF waterfall" entrypoint (it's AM BCB now).examples/README.mdchan_decim=10stage;audio_decim=40(should be 4);--device /dev/sndrecipe (we moved to PulseAudio bind-mount).MANIFEST.mdAuthor Name,Copyright Owner 1, etc.).docs/PLAN.mddocs/README.rx888import rx888instead offrom gnuradio import rx888. Rewritten with correct C++/Python recipes.docker/grc-demo.sh--device /dev/sndpath.include/gnuradio/rx888/source.hsamprateshowed64.8e6.tests/mock/CMakeLists.txtLIBRX888_INCLUDE_DIRSstill listed${CMAKE_SOURCE_DIR}/tests/librx888(deleted when librx888 went upstream).Status section now reads
Test plan
Docs-only with two trivial code touches (header comment + CMake variable). Verified locally:
-DWITH_RX888_MOCK=ONbuild +ctest— bothqa_sourceandqa_source_mockpass (the mock CMake change had no behavior effect because the now-stale path was just being prepended to the include path that already contained the canonical one).Generated by Claude Code