Niman documentation

Four folders, by what each holds:

  • user/ — how to use Niman: getting started, editing, list notes and shopping lists, export, organization, the journal, search, links, templates, tasks and reminders, themes, home-screen widgets, settings, shortcuts, sync, and platform notes.
  • dev/ — how to build and change Niman: architecture, build instructions, code conventions, the documentation site and the release process. Living documentation, kept current with the code.
  • records/ — the design, research and measurement records behind the features, kept as they were written (not kept current): the unified Markdown surface and its parity and huge-note measurements, the rejected editor alternatives, the workspace, the EPUB reader, annotations, the note history and WebDAV sync, the index scan, and transcription. See records/README.md.
  • design/ — the mockups a round was agreed against, one folder per round, with the decision each screen records.

Start with user/getting-started.md if you use the app, or dev/architecture.md if you hack on it.

Edit this page on GitHub