Media
1 item
Description
View Zread.ai documentation for any GitHub repository right on the repo page: sidebar TOC, in-page docs and diagrams. Zread Docs for GitHub brings the Zread.ai AI-generated documentation of a repository directly into the GitHub repository page you are already reading — no tab switching, no separate site. FEATURES • Documentation sidebar: a collapsible table of contents (sections / groups / pages) of the repository's Zread wiki appears beside the README on any repository home page. • In-page reading: click any entry and the document renders right inside the README area, reusing GitHub's own typography, code highlighting and copy buttons. • Diagrams: Mermaid diagrams in the documents are rendered inline, with a fullscreen viewer (zoom, pan, reset). Diagrams with syntax errors fall back to showing their source code instead of an error box. • Section navigation: a slim progress rail on the right tracks the section you are reading; hover it for a table-of-contents card, click to jump to any heading. • Cache & prefetch: documents are cached locally (up to ~50 MB, least-recently-used eviction) and prefetched in the background, so revisits open instantly. • Auto index & refresh: repositories not yet indexed by Zread can be submitted with one click (queue ETA shown); stale documentation is refreshed automatically; old docs stay visible while a refresh runs. • Language: interface and documentation follow your browser language — Chinese when your browser is Chinese, English otherwise. • Dark mode: follows your system preference. • Unobtrusive: the extension never opens visible tabs on its own; all background work happens without new tabs or windows appearing. HOW TO USE 1. Install the extension and open any GitHub repository home page (e.g. https://github.com/owner/repo). 2. The documentation sidebar loads automatically beside the README. 3. Click a page in the tree to read it in place; click the native README tab to restore the original README; use the "Zread Docs" button in the README header to toggle the sidebar. 4. If the repository is not indexed yet, use the one-click submit in the sidebar; the queue estimate is shown while indexing. PRIVACY The extension only communicates with github.com (to show its interface) and zread.ai (to fetch documentation). It reads your zread.ai login cookie solely to authenticate documentation requests when you are logged in, and caches documents on your device. No analytics, no tracking, no advertising. Full policy: https://github.com/ejfkdev/zread-ext/blob/main/PRIVACY.md PERMISSIONS • Cookies on zread.ai — authenticate documentation requests as you, only when logged in. • Scripting & host permission for github.com — show the sidebar and render documents in the README area. • Host permission for zread.ai — fetch documentation, indexing status and refreshes. • Storage — local documentation cache for instant re-open. • Tabs & alarms — manage a hidden background fetch context and schedule background prefetching. SUPPORT Issues and feedback: https://github.com/ejfkdev/zread-ext/issues