docs(readme): describe the window as notes and issues together - #5
Merged
Merged
Conversation
Issues were tacked on as a second paragraph, though they are half of what the plugin does, and nothing said that everything in the window is an ordinary buffer - the property that makes :w, undo and the jumplist work the way they do. Drops the line claiming notes are saved on close, type switch and VimLeavePre: a buffer is written whenever it stops being visible, which the list already says correctly one line below.
There was a problem hiding this comment.
🟡 Changes recommended
The updated README wording can mislead about :w applying to non-file (buftype=nofile) buffers shown in the window.
Once you've addressed the issues Copilot identified, you can request another Copilot review.
Pull request overview
Updates the README to describe the scratch window as a combined notes + lightweight issue tracker, and clarifies how buffers/files behave to better match Neovim’s native editing semantics.
Changes:
- Rewrites the intro to present notes and issues as first-class features in the same floating window.
- Clarifies note scopes and explains that issues are per-file entries shown as a sortable list that opens an issue in-place.
- Removes an inaccurate/duplicative autosave claim in the features list and adds detail about per-project issue lists.
File summaries
| File | Description |
|---|---|
| README.md | Reframes the plugin description around notes + issues together and updates persistence/buffer behavior wording. |
Review details
- Files reviewed: 1/1 changed files
- Comments generated: 1
- Review effort level: Lite
💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.
Comment on lines
+11
to
+13
| Everything the window shows is an ordinary buffer, and everything with a file | ||
| behind it is an ordinary file buffer — so `:w`, undo, `C-o`/`C-i` and the | ||
| cursor position behave exactly as they do anywhere else in Neovim. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Issues were tacked on as a second paragraph, though they are half of what the plugin does, and nothing said that everything in the window is an ordinary buffer - the property that makes :w, undo and the jumplist work the way they do.
Drops the line claiming notes are saved on close, type switch and VimLeavePre: a buffer is written whenever it stops being visible, which the list already says correctly one line below.