docs(fullstack): synchronize architecture and add hardware BOM - #382
Merged
Conversation
GiZano
changed the title
|
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.
Overview
This PR fully synchronizes the project documentation (README, Whitepaper, and Project Website) with the latest QuakeGuard v2.0.1 architecture, specifically reflecting the adoption of the Cloudflare HTTPS tunnel and the extended 300-second anti-replay window. It also adds a critical cross-reference to the newly generated hardware Bill of Materials (BOM) in the GitHub Wiki.
Changes Made
README.md: Updated the anti-replay window references from 60s to 300s to match the actualbackend/src/security.pyimplementation. Added a link to the PCB BOM under the hardware image.docs/whitepaper/02-hardware.typ: Added a dedicated bullet point mentioning the availability of the exact KiCad-derived BOM in the official Wiki.docs/web/quakeguard.html: Enriched the "Proprietary Hardware (v2.0.1)" section with a direct HTML link to the Wiki BOM page.QuakeGuard.wiki.gitrepository, adding the BOM and Triangulation algorithm pages).Impact & Next Steps
These changes ensure 100% coherence across all technical documentation surfaces prior to the final v2.0.1 Zenodo archival, preventing any ambiguities regarding hardware requirements or security thresholds. No subsequent architectural issues are unblocked by this PR, but it provides a clean baseline for future releases.
Testing Performed
README.mdmarkdown rendering locally.docs/web/quakeguard.htmlstructure.Related Issues
Closes # (N/A)