docs: Comprehensive review & revision of documentation for Growth Areas, Discovery, Screening, and Underwriting
Issue Description
Context & Goal
We are systematically refining and documenting the core feature set of the PREI project one module at a time. Each feature requires clear documentation on paruff.github.io/prei/ detailing how it currently works, along with concrete definitions of "Done" and success criteria.
This task directs OpenCode (DeepSeek V4 Flash) to perform an exhaustive review, audit, and revision of the existing documentation across four core functional areas.
Scope of Work
Please review and revise the documentation for the following core areas:
Growth Areas (/docs/...)
Audit current explanation of geographic/market growth tracking.
Clarify data inputs, scoring parameters, and boundary conditions.
Establish clear operational boundaries and definition of "Done".
Discovery Properties (/docs/...)
Audit the property discovery flow within identified growth areas.
Ensure clear mapping between growth area selection and property search triggers.
Clarify criteria for successful discovery and filtering out noise.
Screen Properties (/docs/...)
Audit documentation for preliminary profitability screening.
Detail parameters used for quick-filtering (cap rates, cash flow estimates, price/sqft thresholds).
Document logic for passing screened properties to underwriting.
Underwrite (/docs/...)
Audit financial modeling and deep underwriting logic documentation.
Verify calculation clarity (NOI, IRR, cash-on-cash return, debt service coverage).
Document validation rules for underwriting complete outputs.
Deliverables
[ ] Updated and refined Markdown documentation for each section.
[ ] Explicit "Definition of Done" (DoD) section for each of the 4 features.
[ ] Clearly stated Success Criteria (expected behavior, outputs, and edge-case handling).
[ ] Alignment with public documentation hosted on paruff.github.io/prei/.
Definition of Done (DoD) for this Issue
All 4 target feature documentation pages are updated, accurate to current code/spec, and concise.
Each feature page includes:
Current Functionality Overview
Inputs & Data Sources
Outputs & Expected Data Structure
Definition of Done / Success Criteria
Documentation rendered cleanly for publication on GitHub Pages (paruff.github.io/prei/).
docs: Comprehensive review & revision of documentation for Growth Areas, Discovery, Screening, and Underwriting
Issue Description
Context & Goal
We are systematically refining and documenting the core feature set of the PREI project one module at a time. Each feature requires clear documentation on paruff.github.io/prei/ detailing how it currently works, along with concrete definitions of "Done" and success criteria.
This task directs OpenCode (DeepSeek V4 Flash) to perform an exhaustive review, audit, and revision of the existing documentation across four core functional areas.
Scope of Work
Please review and revise the documentation for the following core areas:
Growth Areas (/docs/...)
Audit current explanation of geographic/market growth tracking.
Clarify data inputs, scoring parameters, and boundary conditions.
Establish clear operational boundaries and definition of "Done".
Discovery Properties (/docs/...)
Audit the property discovery flow within identified growth areas.
Ensure clear mapping between growth area selection and property search triggers.
Clarify criteria for successful discovery and filtering out noise.
Screen Properties (/docs/...)
Audit documentation for preliminary profitability screening.
Detail parameters used for quick-filtering (cap rates, cash flow estimates, price/sqft thresholds).
Document logic for passing screened properties to underwriting.
Underwrite (/docs/...)
Audit financial modeling and deep underwriting logic documentation.
Verify calculation clarity (NOI, IRR, cash-on-cash return, debt service coverage).
Document validation rules for underwriting complete outputs.
Deliverables
[ ] Updated and refined Markdown documentation for each section.
[ ] Explicit "Definition of Done" (DoD) section for each of the 4 features.
[ ] Clearly stated Success Criteria (expected behavior, outputs, and edge-case handling).
[ ] Alignment with public documentation hosted on paruff.github.io/prei/.
Definition of Done (DoD) for this Issue
All 4 target feature documentation pages are updated, accurate to current code/spec, and concise.
Each feature page includes:
Current Functionality Overview
Inputs & Data Sources
Outputs & Expected Data Structure
Definition of Done / Success Criteria
Documentation rendered cleanly for publication on GitHub Pages (paruff.github.io/prei/).