docs: add SETTLEMENT.md to document fund distribution #1791
Open
Johnsource-hub wants to merge 1 commit into
Open
docs: add SETTLEMENT.md to document fund distribution #1791Johnsource-hub wants to merge 1 commit into
Johnsource-hub wants to merge 1 commit into
Conversation
- Create `docs/SETTLEMENT.md` detailing the settlement flow. - Explain splits between investors, treasury, and platform. - Link the new document in the main project README. Closes QuickLendX#1540
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.
Description
Closes #1540
Adds
docs/SETTLEMENT.mdto formalize the settlement logic within the protocol.Purpose
This document serves as a technical reference for contributors and auditors to verify the fund distribution behavior against the protocol's documented intent. It transitions the settlement flow logic from tribal knowledge into a searchable, version-controlled reference.
Changes Made
docs/SETTLEMENT.mdcovering the settlement lifecycle, including specific splits for investors, the treasury, and the platform.README.mdto include a link to this new settlement specification.Audience
The document is targeted at contributors and auditors, focusing on the logic paths during settlement.
Acceptance Criteria