chore: move IMPLEMENTATION_SUMMARY.md to docs/archive - #622
Open
joshfatoye0011-bit wants to merge 3 commits into
Open
chore: move IMPLEMENTATION_SUMMARY.md to docs/archive#622joshfatoye0011-bit wants to merge 3 commits into
joshfatoye0011-bit wants to merge 3 commits into
Conversation
…oses FlowwStar#521 The API reference and README both claimed the contract exposed 12 public functions. A grep of contracts/streaming/src/lib.rs shows 28. This commit documents the 16 previously undocumented functions following the existing per-function pattern (signature, params, authorization, preconditions, returns, behavior, example): Admin / lifecycle (5): initialize, pause, unpause, upgrade, migrate Core write (2 new): create_streams_batch, cleanup_stream Query (2 new): get_archived_sent_streams, get_archived_received_streams Metadata (2): update_stream_metadata, get_stream_metadata Delegation (3): set_delegate, remove_delegate, get_delegate Contract info (2): version, name Additional fixes: - bump_stream: corrected auth claim (no auth required, not sender-only) - README TTL FAQ: 30 days not 6 months (matches PERSISTENT_TTL_LEDGERS) - README max-duration FAQ: 10-year hard cap documented - Auth table in README expanded to all 17 write/admin operations - Type Definitions updated: Stream gains linear_amount + duration fields; CreateStreamInput and StreamMetadata interfaces added
…ion for newcomers by relocating the internal AI-agent work log out of the repo root and into docs/archive, where it won't be mistaken for authoritative project documentation. Closes FlowwStar#516
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.
Summary Moves IMPLEMENTATION_SUMMARY.md from the repo root to docs/archive/IMPLEMENTATION_SUMMARY.md. ## Problem The file is an internal AI-agent work log (branch names, PR-ready checklists) that was committed at the repo root alongside README and CONTRIBUTING, causing confusion for newcomers about what counts as authoritative project documentation. ## Change - Renamed/moved: IMPLEMENTATION_SUMMARY.md → docs/archive/IMPLEMENTATION_SUMMARY.md - No code or logic changes. Closes #516