Overhaul docs to reflect deterministic-lossy fingerprinting narrative, add limitations, and align tests - #27
Draft
cto-new[bot] wants to merge 1 commit into
Draft
Conversation
…rrative Overhaul README hero and documentation to align with the supplied deterministic-lossy fingerprint narrative. Add a formal Limitations section, refresh architecture/security docs, and ensure cross-linked references to limitations. Update quick-start snippets to reference micro-tier and integrity guard with real metrics (300-byte embeddings, 22% MSE improvement, SHA256 latency). Adjust tests to reflect new payload handling (dict or FrackturePayload dataclass) and tiny-tier semantics, with relaxed expectations where appropriate. No breaking changes to public API; payloads remain accessible as dict-like objects or as FrackturePayload dataclass for compatibility. ### Summary This PR overhauls project documentation to reflect the supplied deterministic-lossy fingerprinting narrative, adds a formal Limitations section, updates architecture and security docs, cross-links to new limitations, and aligns tests with the new payload structure and tiny-tier behavior. ### Details - Rewrote README hero to include the deterministic narrative, five-point core value proposition, explicit limitations, and updated quick-start snippets referencing micro-tier and integrity guard; replaced hype text with actual metrics (300-byte embeddings, 22% MSE improvement, SHA256 latency comparisons). - Added docs/Limitations.md with a dedicated “Limitations & Status” section covering tiny payload caveats, fault-injection guarantees, reconstruction error bounds, throughput variability, and transparency links. - Refreshed architecture and security docs (docs/ARCHITECTURE.md, docs/SECURITY.md, docs/README.md) to describe the dual-channel design, self-optimizing loop, integrity token, and tier-specific serialization; include updated diagrams/flow tables and callouts for funded tiers if substantiated. - Updated docs/README.md to cross-link the new Limitations section and ensure all docs reference it. - Updated tests to reflect payload representation changes (support for dict or FrackturePayload dataclass, relaxed expectations for tiny payloads) and ensure compatibility with new serialization semantics; updated access patterns accordingly. - Maintained backward compatibility: payload may be accessed as a dict-like object or as a FrackturePayload dataclass; no breaking API changes to end-user usage. - No breaking changes to the public API surface. ### Breaking Changes None
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.
Summary
This PR overhauls project documentation to reflect the supplied deterministic-lossy fingerprinting narrative, adds a formal Limitations section, updates architecture and security docs, cross-links to new limitations, and aligns tests with the new payload structure and tiny-tier behavior.
Details