Skip to content

Docs: align docs with current repo state#164

Merged
vishalchangrani merged 4 commits intomainfrom
lionel/audit-docs-alignment
Feb 14, 2026
Merged

Docs: align docs with current repo state#164
vishalchangrani merged 4 commits intomainfrom
lionel/audit-docs-alignment

Conversation

@liobrasil
Copy link
Contributor

@liobrasil liobrasil commented Feb 13, 2026

Align documentation with the current contracts/tests/transactions for audit readiness.

Changes:

  • Update README + testing instructions
  • Update docs (auto-borrowing, liquidation design, deposit capacity)
  • Mark legacy contract file as reference-only
  • Remove obsolete milestone doc

@liobrasil liobrasil requested a review from a team as a code owner February 13, 2026 23:21
Copy link
Member

@Kay-Zee Kay-Zee left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM, although i did already move the alpenflow initial draft to the docs folder in a different PR #162

## Executive Summary

This document provides a comprehensive analysis of the existing test coverage for the FlowALPv1 lending protocol, an automated lending system similar to Aave built on the Flow blockchain using the Cadence programming language. The protocol has achieved 89.7% code coverage with 31 core test files covering fundamental operations, interest mechanics, liquidations, and edge cases.
This document provides a narrative-style analysis of the existing test coverage for the FlowALPv1 lending protocol, an automated lending system similar to Aave built on the Flow blockchain using the Cadence programming language. The protocol has an extensive test suite covering fundamental operations, interest mechanics, liquidations, and edge cases.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

i agree with not using comprehensive, but what does it mean for it to be a narrative style analysis?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I've updated this to be clearer for the reader

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I've used walkthrough of the existing... instead

@liobrasil liobrasil force-pushed the lionel/audit-docs-alignment branch from 1784ac0 to 9bd6b5c Compare February 14, 2026 00:18
@vishalchangrani vishalchangrani merged commit abea0e2 into main Feb 14, 2026
1 check passed
@vishalchangrani vishalchangrani deleted the lionel/audit-docs-alignment branch February 14, 2026 02:12
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

5 participants