Repository navigation
zdxsv docs: architecture overview, desync investigation, upstream merge and release procedures - #693
Merged
Merged
Conversation
…ge and release procedures Co-Authored-By: Claude Opus 5.5 <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
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.
Description of Changes
Three new documents for a reader who did not write the code, listed in the README table:
docs/zdxsv/architecture.md: processes and threads with the state each touches, a battle frame as one picture, trust boundaries (each outside input, who controls it, where it enters), kinds of failure and what the player sees.docs/zdxsv/desync.md: an ordered procedure from the emulog's desync line to the guest code that wrote the differing value, using the existing traces, dumps and tools.docs/zdxsv/maintenance.md: merging upstream PCSX2, cutting a release, rolling one back (the updater never downgrades; the server's minimum version).Rationale behind Changes
The topic documents hold accurate constants but no overview or procedures; these link to them instead of repeating them.
Suggested Testing Steps
Docs only. Checked on windows-mini: every relative link, referenced section and file path resolves; the merge commands of
maintenance.mdwere run against current upstreammaster(merge stops on conflicts in the file kinds the document lists). Not run: the release and rollback steps, a desync investigation end to end.Did you use AI to help find, test, or implement this issue or feature?
Yes: written by an AI agent from the code and the existing documents.
🤖 Generated with Claude Code