Replace docs scaffold with real content and download links#2
Merged
Conversation
The docs site shipped as scaffold: pages told the reader to add commands later, the CLI reference listed only version, the troubleshooting page named flags that do not exist (--rate, -v) and a cookie session model that does not apply to HN, and the template examples used the wrong field casing. Rewrite every page against the real tool: - Installation now leads with a per-platform download table linking the v0.1.1 prebuilt archives, plus copy-paste install steps for macOS/Linux/Windows, native deb/rpm/apk commands, go install, Docker, source, and cosign verification. - Five task guides (front page, threads, search, users, scripting) built around jobs rather than commands. - CLI reference lists every command with its own flags and the global flag set. - Output, configuration, and troubleshooting pages corrected to the actual formats, flags (--delay, -j, -q), lowercase template keys, and exit codes. - Home and quick-start show real commands and sample output. - Added the v0.1.1 release note.
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.
The docs site shipped as scaffold. Pages told the reader to "add commands as you build", the CLI reference listed only
version, the troubleshooting page referenced flags that do not exist (--rate,-v) and a cookie/session model that does not apply to Hacker News, and the template examples used the wrong field casing.Every page is rewritten against the real tool and verified with a local
tago build(20 pages, clean).Installation gets real download links
The page now leads with a per-platform table linking every v0.1.1 prebuilt archive (macOS/Linux/Windows/FreeBSD across amd64/arm64/armv7/386), plus:
curl+tar+install) and Windowsgo install, Docker (GHCR), and from-sourceGuides
Five task-oriented walkthroughs replace the empty section: browse the front page, read a thread, search and filter, follow a user, and pipe into jq.
Reference corrected to the actual surface
item --depth,user --submissions,search --tags/--sort/--since/--points/--comments) and the full global flag set.--fields,--no-header, and lowercase template keys with thejoinfunction.-j,--delay,--timeout,--retries), and the fact that there are no env vars.--delay/-j, and the macOS quarantine fix.Home, quick-start, release notes
Real commands and sample output; added the v0.1.1 release note.
After merge the Docs workflow redeploys to GitHub Pages and Cloudflare Pages.