Docs: integrate recent changes; drop tracked binary + PDF#5
Merged
Conversation
Documentation refresh covering everything landed since the last doc pass: STEP derivative download, performance optimisations, the security fixes from PR #1 (H1/H2/M2), and the three-phase test suite from PRs #2-4. Also removes the tracked FusionDataCLI binary (11MB) and README.pdf (587KB) from the repo and adds gitignore guards so they don't return. Files updated: README.md key table corrections (`d` is STEP download, not "toggle details"; `h` is hub picker, not back-nav); STEP download section; CI badge; pointer to docs/development.md docs/api.md STEP derivative query + polling pattern; pagination cap (50) rationale; X-Ads-Region header; SetGraphqlEndpointForTesting hook docs/architecture.md internal/testutil package; three-layer test strategy; const->var injection pattern; performance optimisations (detailsCache, styleCache, parallel fetches) docs/authentication.md OAuth callback now binds 127.0.0.1; reflected error params HTML-escaped; bearer not attached to signed-URL downloads; validFileID whitelist + JSON-encoded fileId in MCP insert script; pending follow-ups pointer to SECURITY-TODO.md docs/development.md test suite section (make check, CI workflow, coverage breakdown); three-layer summary; internal/testutil usage; const->var test- injection pattern; SetGraphqlEndpointForTesting use case docs/navigation.md STEP download workflow; key bindings audited against ui/keys.go; details panel doc updated (always visible now, was previously documented as toggleable) .gitignore *.pdf and coverage.out guards Removed: FusionDataCLI built binary (11MB) — gitignored alongside lowercase `fusiondatacli` already README.pdf PDF export of README (587KB) — readers should use the rendered Markdown on GitHub or locally; keeping the PDF in sync was a manual chore that consistently drifted Factual contradictions found and fixed: - README + navigation.md both said `d` toggled the details panel; the actual binding (ui/keys.go:62-64) is download STEP. - Both said `h` was a back-nav alias for `<-`; actual binding (ui/keys.go:65-68) is hub picker. - navigation.md described the details panel as toggleable; it has been always-visible since the column-layout refactor (ui/app.go comment at line 131 confirms). - api.md said pagination "1-99 (max of 100 is exclusive)"; the actual cap is 50, driven by APS query-cost limits with this app's field set (api/queries.go:11-14 explains). - api.md and authentication.md misrepresented the 401 short-circuit error string and the callback bind address (was 0.0.0.0 in practice; now explicitly 127.0.0.1 per the H1 fix). Build + tests verified green after edits. Co-Authored-By: Claude Opus 4.7 (1M context) <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.
Summary
Documentation refresh covering everything landed since the last doc pass: STEP derivative download, performance optimisations, the security fixes from #1 (H1/H2/M2), and the three-phase test suite from #2/#3/#4. Also removes the tracked
FusionDataCLIbinary (11 MB) andREADME.pdf(587 KB) from the repo and adds gitignore guards so they don't return.Changes
README.mddis STEP download, not "toggle details";his hub picker, not back-nav); STEP download section; CI badge; Development sectiondocs/api.mdX-Ads-Regionheader;SetGraphqlEndpointForTestinghookdocs/architecture.mdinternal/testutilpackage; three-layer test strategy; const→var injection pattern; performance optimisationsdocs/authentication.md127.0.0.1; reflected error params HTML-escaped; bearer not attached to signed URLs;validFileIDwhitelist + JSON-encoded fileId;SECURITY-TODO.mdpointerdocs/development.mdinternal/testutilusage, const→var pattern explaineddocs/navigation.mdui/keys.go; details panel doc updated (always-visible).gitignore*.pdfandcoverage.outguardsRemoved
FusionDataCLI— built binary (11 MB). The lowercasefusiondatacliwas already gitignored; the capitalised version slipped in once and lingered.README.pdf— manual PDF export. Readers should use the rendered Markdown on GitHub. Keeping the PDF in sync was a recurring chore.Factual contradictions fixed
README.md+docs/navigation.md:dwas documented as "toggle details panel"; actual binding (ui/keys.go:62-64) is download STEP.hwas documented as a back-nav alias for←; actual binding (ui/keys.go:65-68) is hub picker.docs/navigation.md: described the details panel as toggleable; it has been always-visible since the column-layout refactor.docs/api.md: said pagination accepts 1–99; actual cap is 50, driven by APS query-cost limits.docs/authentication.md: said callback "listens only on loopback"; was bound to0.0.0.0in practice until the H1 fix made that statement true.Test plan
go build ./...greengo vet ./...greengo test -race ./...green🤖 Generated with Claude Code