docs: revamp README landing page, add CONTRIBUTING.md and vimdoc#88
Merged
Conversation
Restructure the README around the core value prop (review AI-agent edits as native Neovim diffs) and split maintainer/reference content out of it. README: - Conversion-oriented top-of-fold: logo, tagline, badges, hero, visible demo - Hoist one working demo GIF above the fold; collapse the rest - Dedupe Quick start into a shared flow + per-agent distinct steps - Replace the exhaustive config block with a pointer to :help code-preview-config - Keep only a user-altitude "How it works" (diagram + link to CONTRIBUTING) - Align prose terminology with CONTEXT.md (agent / preview) - Soften unverifiable "OpenCode >= 1.3.0" to non-version wording New CONTRIBUTING.md: architecture, internals (hook entry, RPC, in-process core handler, per-agent integrations), and testing; links to CONTEXT.md and docs/adr/. Corrects the stale claim that all agents have backends/ adapters (only OpenCode does). New doc/code-preview.txt: vimdoc reference with :help tags; canonical config block copied verbatim from lua/code-preview/init.lua. Consolidate all README media under assets/ (git mv the GIFs from docs/), wire the header to assets/logo.svg, and gitignore generated doc/tags. Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
Add a fuller opinionated lazy.nvim example (inline layout, per-agent override, neo-tree git root) and document diff.defer_claude_permissions as a caveated opt-out, per ADR-0002's call to make the override discoverable. Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
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
1 participant
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.
Summary
Revamps the README into a conversion-oriented landing page and splits maintainer/reference content into dedicated files, ahead of the v2.3.0 release. README drops from 471 → ~320 lines while adding previously-undocumented config (
diff.layouts).README
<leader>dq" note stated once.layout/ per-agentlayoutsexamples and points to:help code-preview-configinstead of inlining the ~50-line block.CONTEXT.md(agent, preview).diff.layouts(keysclaudecode | opencode | copilot | codex) andneo_tree.refresh_on_change.New:
CONTRIBUTING.mdArchitecture + internals (hook entry, RPC, in-process core handler, per-agent integrations) + testing. Links down to
CONTEXT.mdanddocs/adr/rather than duplicating them. Corrects the stale claim that all agents havebackends/adapters — only OpenCode does.New:
doc/code-preview.txt(vimdoc):helptags forcode-preview,-config,-commands,-keymaps,-agents, plus a tag per command.:helptagsvalidates (25 tags). The canonical config block is copied verbatim fromlua/code-preview/init.lua.Assets
assets/(git mvof the 5 GIFs fromdocs/, history preserved).assets/logo.svg;assets/diff-preview.pngis the hero.doc/tagsadded to.gitignore(plugin managers regenerate it).Verification notes
.codex/hooks.json(code),approval_policy = "on-request"+sandbox_mode = "read-only"(documented Codex values)🤖 Generated with Claude Code