Skip to content

docs: review pass on accuracy, clarity, and styling - #68

Merged
everpcpc merged 2 commits into
mainfrom
docs/review-polish
Oct 25, 2026
Merged

everpcpc merged 2 commits into
mainfrom
docs/review-polish

Conversation

@everpcpc

Copy link
Copy Markdown
Member

Summary

A review pass over the docs, landing pages, and styles. Claims were checked against the KMReader and kmrs sources.

Accuracy

  • Migration: step 3 ran docker run --name=komga while the stopped komga container still existed, which fails with a name conflict. The guide now renames the old container to komga-java and names the new one kmrs, the same name the Compose examples use. It also explains how to switch back and that kmrs.sqlite holds KMServer-only data.
  • Privacy policy:
    • Credentials are stored in the app database inside the sandbox, not in Keychain.
    • OCR model packs are downloaded from models.kmworks.date; the policy now discloses this.
    • With the opt-in "Include Comic Metadata" setting, series and chapter titles, authors, and genres are sent to the translation provider. The page, the translation guide, and the blog now say so consistently.
  • Platforms: release archives cover Linux x86_64/aarch64, macOS arm64/x86_64, and Windows x86_64 only. The Linux binaries link glibc, so "static" became "self-contained".
  • Installation: release archives don't include libpdfium, which is needed for PDFs. The komf auth wording now matches the komf page.
  • Blog: KMReader 7.2 has shipped; the "in preparation" wording is removed.
  • Smaller fixes:
    • Trackers page: documents disconnecting, the per-library filter, and the default platform.
    • History retention: uses the correct [history] retention-days key.
    • Sidebar order collisions resolved.
    • "Komga" capitalized consistently.

Clarity

  • "Behavior differences" is split into five subsections, which now show up in the page TOC.
  • The Windows tray paragraph is now a list.
  • Limitations now has an "Out of scope" section.
  • FAQ: two duplicate entries merged, a link to Known limitations added, and the "clients reconnect without changes" claim corrected.
  • Compare page: rows added where the web UI wins (no install, any OS, full administration), so the "neutral" framing holds.
  • Landing:
    • Hero line now reads "native on every Apple device" instead of "Native everywhere".
    • Screenshot width/height match the real files (the iPad shots are 4:3 landscape), which avoids layout shift.
    • The ecosystem diagram hangs the Apple devices under KMReader only.

Styling

  • The header button uses the amber brand style and links to the KMServer download on /server/* pages.
  • Docs links and the current sidebar entry use the kmworks accent, with a darker accent for text contrast on light backgrounds.
  • Inline code chips keep their border when a long path wraps.
  • Compare table: the first column stays fixed while the other columns scroll on phones.
  • The hero screenshots no longer extend past the page gutter on narrow screens.

Test plan

  • pnpm typecheck, pnpm build, pnpm lint:docs (internal links included), nimbus-docs check: all clean
  • Checked in the browser at 1440px and 375px, light and dark: landing, compare, installation, enhancements

🤖 Generated with Claude Code

everpcpc and others added 2 commits October 25, 2026 18:41
- Migration: rename the old Komga container so `docker run --name=kmrs`
  no longer collides with it, and explain switching back
- Privacy: credentials live in the app database, not Keychain; disclose
  model-pack downloads from models.kmworks.date and the opt-in comic
  metadata sent to translation providers
- Platforms: no Windows aarch64 build, and binaries are self-contained
  rather than static
- Installation: libpdfium is needed for PDFs with release binaries;
  komf auth wording matches the komf page; Windows tray as a list
- Trackers: document disconnecting, library filter, default platform
- Fix history retention key, sidebar orders, Komga capitalization
- Group behavior differences under subheadings
- FAQ/compare/landing: drop duplicate FAQ, balance the compare table,
  correct screenshot dimensions and alt text, hang Apple devices under
  KMReader only in the ecosystem diagram

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
- Header CTA uses the amber brand button and offers the KMServer
  download on server pages
- Docs links and the current sidebar entry use the kmworks accent
- Inline code chips keep their border when a long path wraps
- Compare table keeps the capability column sticky on phones
- Hero screenshots stay inside the page gutter on narrow screens

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
@everpcpc
everpcpc merged commit 7d84663 into main Oct 25, 2026
1 check passed
@everpcpc
everpcpc deleted the docs/review-polish branch October 25, 2026 10:44
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant