chore: update documentation for database operations and IPC structure - #113
Merged
Conversation
- Clarified database access rules in `.cursorrules`, specifying that user-triggered `VACUUM` may run in a dedicated maintenance worker to avoid blocking the Main IPC loop. - Enhanced `README.md` to reflect the English-only UI copy policy and updated settings documentation to include the new Danger-zone wipe functionality. - Updated `api-guide.md` to note the integrity gap in video-cache writes and the implications for users. - Revised `architecture.md` to include recent changes in controller responsibilities and IPC structure. - Adjusted `glossary.md` to define new terms related to data wiping and video proxy integrity. These updates aim to improve clarity and maintainability of documentation, ensuring developers and users are well-informed about system operations and limitations.
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.
.cursorrules, specifying that user-triggeredVACUUMmay run in a dedicated maintenance worker to avoid blocking the Main IPC loop.README.mdto reflect the English-only UI copy policy and updated settings documentation to include the new Danger-zone wipe functionality.api-guide.mdto note the integrity gap in video-cache writes and the implications for users.architecture.mdto include recent changes in controller responsibilities and IPC structure.glossary.mdto define new terms related to data wiping and video proxy integrity.These updates aim to improve clarity and maintainability of documentation, ensuring developers and users are well-informed about system operations and limitations.