Repository navigation
Docs: accurate README build/test/CI, API route index, open follow-ups - #5
Merged
Merged
Conversation
README: the iOS client caveat described a bare gitlink that no longer
exists (the sources are vendored and CI tests them); the build section now
lists the Linux targets and the Go/Node requirements; the hwaccel note says
VideoToolbox is macOS-only; a Web UI table names every embedded page with a
screenshots placeholder; the Tests and CI paragraphs describe what actually
runs (web client tests, deploy script tests, the four CI jobs).
API.md: the reference-implementation note pointed at a `go-port` branch;
the Go server is on main and authoritative. The Audiobooks section lists
the chapter, download, chapter-lookup/map and conversion routes, a new
Ebooks section covers /api/ebooks, /ebooks and /read/{id}, Artwork gains
the curated poster route, and a Route index documents every other
registered route that had no entry: movie continue/preparation/VOD/HLS,
reading lists, the shared reading queue and Google link, catalog reports,
settings and maintenance, the Jellyfin and Audiobookshelf compatibility
surfaces, and the browser pages and static assets.
REFACTOR_CHECKLIST.md: every item was checked; a new section records the
open Go server follow-ups found in this audit (staticcheck dead code, the
unserved /project-analytics.js, macOS-only template paths, the phone header
strip affordance, adding staticcheck to CI).
Co-Authored-By: Claude Fable 5.1 <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
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-only PR that brings
README.md,API.mdandREFACTOR_CHECKLIST.mdin line with what the repository actually contains. Every route and behaviour added toAPI.mdwas checked againstserver/internal/httpapi/server.goand the handlers before being written down.What changed
IOS_Client_Xcode/TM_Sonder_Clientbeing a bare gitlink is stale: the sources are vendored and CI runs their tests and an unsigned build. Replaced with the accurate note.make linux/make linux-amd64alongsidemake mac, and the Go 1.25 / Node requirements.transcode.hwaccelnote: VideoToolbox is macOS-only; Linux should usenone/vaapi/qsv.make testcomment, the Tests section (adds the web client and deploy script tests) and the CI paragraph (four jobs, including the linux/amd64 cross-compile and the iOS job) now matchMakefileandci.yml.go-portbranch; the Go server is onmainand authoritative, the macOS embedded server is legacy./api/ebooks,/ebooks,/read/{id}); Artwork gains/artwork/curated/{id}./project-analytics.js, macOS-only template paths, phone header strip affordance, staticcheck in CI).How verified
grep HandleFunc server/internal/httpapi/server.go(139 registrations); each one-line purpose checked against the handler or the existingdocs/*.mdnote for that feature.Risks / follow-ups
API.mddoes not document for those clients today.🤖 Generated with Claude Code