Skip to main content

Where do I look for…

A map from what you want to change to the file that does it, and to the chapter that explains it.

You know what you want to change ("the page turn feels slow", "this CSS property is ignored"), but not where it lives. Search for a word, or filter by area. Each line gives the files and functions to open, the chapter of this site that teaches the idea, and the reference document for the details.

SearchTask → code
Try this: Type sync, then pg4, then css. Or pick an area, like Books.

When the map is not enough​

  • The layer cake tells you which domain a question belongs to: pixels are in graphics, text on pages in typesetting, files on the reader in shelf.
  • Each package starts with a doc.go that teaches its domain: go doc ./internal/shelf prints it.
  • Functions marked HOT PATH in their comment are tuned for the reader's processor: read Making a change before touching one.
  • Some behavior only the reader shows: real ghosting, its speed, Wi-Fi, sleep. The app logs page turn times, refresh waits, downloads and errors to applications/inkshelf.log, readable over USB. To find where a slow page turn spends its time, profile it: Finding what is slow.

The source of this map: the end of Architecture.

Found the file? Making a change says how to change it safely.