Rework documentation #817
Merged
Rework documentation #817
Conversation
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
There was a problem hiding this comment.
Pull Request Overview
This PR reorganizes and refreshes the libvfio-user documentation to make it more maintainable and user-friendly. The changes include recommending QEMU 10.1.1 or later, restructuring the main README for better navigation, and referring to QEMU for the canonical protocol definition to avoid maintaining duplicate specifications.
- Remove the local vfio-user protocol specification and refer to QEMU's canonical version
- Update QEMU version recommendations from a custom branch to the official 10.1.1 release
- Reorganize documentation into focused topic-specific files for better navigation
Reviewed Changes
Copilot reviewed 9 out of 9 changed files in this pull request and generated 1 comment.
Show a summary per file
| File | Description |
|---|---|
| meson.build | Remove docs subdirectory from build |
| docs/vfio-user.rst | Remove entire protocol specification file |
| docs/meson.build | Remove documentation build configuration |
| docs/spdk.md | Update QEMU version requirement and simplify build instructions |
| docs/qemu.md | Update QEMU version requirement and remove extra whitespace |
| docs/libvirt.md | Add new focused documentation for libvirt configuration |
| docs/examples.md | Extract examples section from main README into dedicated file |
| docs/develop.md | Create new developer-focused documentation |
| README.md | Restructure and simplify main README, removing duplicated content |
Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.
Refresh and re-organize the documentation, in particular: - recommend QEMU 10.1.1 or later - make the main README shorter and easier to navigate - refer to QEMU for the protocol definition so we don't have two copies Signed-off-by: John Levon <[email protected]>
swapnili
approved these changes
Oct 10, 2025
This was referenced Oct 10, 2025
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.
Refresh and re-organize the documentation, in particular:
Signed-off-by: John Levon [email protected]