---
title: Docs README
tags: [mortgagefi, moc]
type: moc
status: stable
updated: 2026-06-14
---

# MortgageFi Documentation

This folder is an **Obsidian vault**. Open it in [Obsidian](https://obsidian.md) for backlinks, the graph view, and live wikilinks — or browse the Markdown directly on Git.

> [!tip] Start at [[Home]]
> [[Home]] is the Map of Content with links to every note.

## Quick links

### Architecture
- [[Architecture]] — system overview, component diagrams, and data flows
- [[API Reference]] — REST API for nftcache, the scheduler, and ntfy

### Operations
- [[Deployment]] — Docker Compose, Vercel, and standalone deployment guides
- [[Development]] — local setup, adding chains, testing, troubleshooting
- [[Migration Notes]] — library upgrade notes & rollback plan
- [[Alert Changes]] — notification & scheduling behaviour history

### Audits
- [[Security Audit]] · [[Performance Audit]] · [[Project Audit 2026-06]]

## What is MortgageFi?

A decentralized mortgage-lending platform that lets users:

- **Deposit NFT collateral** into audited debt vaults
- **Borrow stablecoins** against crypto collateral (cbBTC, WETH, WBTC)
- **Pay down debt** on-chain to extend liquidation timers
- **Receive alerts** via email and push notifications before liquidation

## Folder layout

```
docs/
├── Home.md                 ← Map of Content (start here)
├── Architecture/
│   ├── Architecture.md
│   └── API Reference.md
├── Operations/
│   ├── Deployment.md
│   ├── Development.md
│   ├── Migration Notes.md
│   └── Alert Changes.md
└── Audits/
    ├── Security Audit.md
    ├── Performance Audit.md
    └── Project Audit 2026-06.md
```

## Related
[[Home]] · [[Architecture]] · [[Deployment]] · [[Development]]