Repository navigation
docs: add help file for nvim and rework documentation - #518
Conversation
|
Documentation screenshots for #518. Overview, context, and review images are reused from the original documentation; health and mention completion were captured with Hollow using the configured Neovim setup.
|
3f38ed0 to
e9d0023
Compare
|
New screenshots for
|
sudo-tee
changed the title
Replace the monolithic README with a short overview and a docs/ tree covering getting started, usage, context, review, configuration, reference, extensions, servers, and troubleshooting. Trim the vimdoc entry point to a summary that links into docs/, and add a CONTRIBUTING guide with the documentation conventions. Add :Opencode debug events [filename] and :Opencode debug log commands with matching api.debug_events/api.debug_log helpers, so captured events can be exported and the plugin log opened without reaching into Lua. Update the manual testing notes to use the new command.
Document prompt history and Markdown rendering, link each README feature to its section, and add screenshots for the history, session, and timeline pickers, panel tabs, permission prompts, and quick chat. Images are hosted on the docs-assets branch.
Add a worktree sessions recipe showing how to keep a per-worktree conversation in its own panel tab via api.open_session and a local slash command, without changing Neovim's working directory.
984552e to
4f68baa
Compare
|
That's great! Also, if you don't mind the theme being a little inconsistent, you could ask the agent to add some of the GIFs I made earlier to this document. You can still let me know what theme you’re using, so I can match it when I record GIFs in the future |
64f49e6 to
891e3f6
Compare
|
I use kanagawa wave as a theme. I already tasked my agent to generate a bunch of screenshots for me. For the gifs I tried, but the agent was alittle to slow to execute the commands so the gifs were not really usefull. But if you want to give it a try you are welcome. I plan on merging what I have soon so we can iterate on it and improve it. Just having it splitted in multiple doc is already a huge improvement |
|
Picker screenshots published to the dedicated Captured with |
2 participants
This is an MR for the future docs rework of this plugin