The top-level README is the tour: what nightcrow is, how to install it, and enough usage to get a session up. Everything past that lives here, one page per surface.
| Page | What it covers |
|---|---|
| Getting started | Install, starting and stopping a session, attaching, startup panes |
| Projects | Repository tabs, the empty state, per-project scope |
| Views | Status, commit log, and tree views; the notice row; the repo dialog and its directory browser |
| Keyboard and mouse | The leader key, every binding, mouse routing |
| Session state | Recent-activity highlighting, what persists across restarts and who owns it |
| Web viewer | The browser surface, phone layout, authentication, frontend development |
| Plugins | The plugin boundary and the bundled nightcrow-recovery |
| Configuration | Every config.toml table, and which ones reload without a restart |
| Page | What it covers |
|---|---|
| Architecture | Index: overview, layout, module map, stack — and links into the detail pages below |
| · Session | Daemon ↔ client split, TerminalBackend, PTY size ownership, config reload |
| · Git views | Diff pipeline, gutter and wrapping, tree navigator, commit-log decoration |
| · Terminal | Split-view pane grid, emulation layer, scroll and mouse routing |
| · UI | Keyboard routing, the Workspace/App project boundary, notice row |
| · Plugin host | The trust boundary and the recovery surface |
| · Web layer | Shared HTTP/SSE primitives, the viewer, the frontend |
| Design decisions | Why it went this way — rejected alternatives and where implementation diverged from plan |
| AGENTS.md | Contribution workflow and repository conventions |