What notes are
In Rinne, a note is a plain Markdown file associated with a snapshot. It exists to explain the checkpoint in human terms.
The snapshot tells you what the state was. The note tells you why that state matters.
Why plain Markdown matters
Notes stay easy to read because they are plain text. Any editor can open them, and other tools can search, diff, copy, or archive them.
This keeps the format simple and durable. Your explanation does not disappear behind an app-only field.
- Readable: open it in any text editor.
- Portable: easy to search, copy, and reuse.
- Stable: still understandable even if your tooling changes later.
How notes fit the workflow
The note command lets you list notes, show one, append text, overwrite it,
or clear it. That keeps note-taking close to the snapshot workflow instead of turning it into a separate task.
You do not need a long write-up. One honest paragraph is usually enough to make a checkpoint useful later.
What to write
Keep it practical. The most useful notes usually answer just three things.
- what changed
- why you saved
- what to do next
Early Access note: specific commands and outputs may change. The concepts remain stable.