docs: beginner Docker quickstart one-pager for GitHub Pages#8
Merged
Conversation
Standalone HTML walk-through from a fresh Ubuntu terminal to a running AM Broadcast Band flowgraph: USB-3 plug-in, lsusb verify, docker.io install, usbfs_memory_mb bump, clone + docker/build.sh, xhost, the full grc-demo run line, and a troubleshooting section covering the errors a first-timer hits (docker group, USB-2 fallback, NO_MEM, no DISPLAY, missing pulse socket, flat spectrum). Served as /docs/index.html with a .nojekyll sibling so Pages publishes the file verbatim (no Jekyll processing). README points new users to the rendered page at ringof.github.io/gr-rx888.
Adds paths-ignore to both push and pull_request triggers so changes under docs/ or to any *.md file don't kick off the full build matrix (ubuntu-22.04 + 24.04 builds, mock, ASan, TSan, valgrind, lint, docker image). The Dockerfile, scripts, and source remain covered.
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
docs/index.htmlwalks a brand-new Ubuntu user from a fresh terminal to a running AM Broadcast Band flowgraph. No Docker or GNU Radio experience assumed.lsusbverify,docker.ioinstall + group, theusbfs_memory_mbbump (theLIBUSB_ERROR_NO_MEMfootgun),xhost +local:docker, and the fullgrc-demorun line with the audio/X11/USB bind mounts unpacked in a<details>block.docs/.nojekyllsibling so Pages serves the file verbatim — no Jekyll processing, no theme dependency.ringof.github.io/gr-rx888.Test plan
main//docs(or whichever source you've already chosen).prefers-color-schemerule) and check legibility.Setup of GitHub Pages
If Pages isn't yet pointed at this folder, choose Settings → Pages → Build and deployment → Source: "Deploy from a branch", branch
main, folder/docs. The.nojekyllmarker is already in place so the HTML is served as-is.Generated by Claude Code