docs: add investor workflow guides for growth, discovery, screening, underwriting - #336
Merged
Conversation
Devcontainer failed to boot with 'No module named structlog' because structlog was only a transitive dep of django-structlog and the container's Python (3.14 from the 'latest' feature) predated it. - Pin structlog==26.1.0 in requirements.txt (direct import in settings and middleware) - Guard the structlog import in core/middleware.py to degrade to no-op logging instead of crashing the whole WSGI app (matches settings.py) - Pin devcontainer python feature to 3.13 to match the base image
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
Comprehensive documentation review & revision for the Growth Areas → Discovery → Screening → Underwriting investor workflow (issue #335).
New guides
docs/explanation/investor-workflow.md— 4-stage navigation mapdocs/how-to-guides/analyze-growth-areas.md— Growth Explorer step-by-stepdocs/how-to-guides/discover-properties.md— source types + rent-data caveatsdocs/how-to-guides/screen-properties.md— hard kills vs soft scoringdocs/how-to-guides/underwrite-deals.md— pipeline underwriting vs BRRRRdocs/reference/ui-patterns.md— design-system component referenceUpdated
docs/explanation/GACS_GUIDE.md— fixed stale GACS v1 → v2 (7 signals, 0–100 scale, QCEW county employment with FRED fallback, weights 30/15/15/10/15/10/5) to matchcore/models/growth.pydocs/index.md,docs/README.md, section indexes,mkdocs.ymlnavdocs/implementation-summary-growth-areas.md→docs/assessments/Validation
manage.py checkclean; live smoke: all 6 documented pages return 200core/services/*.pyand templatesNotes
docs/explanation/index.mdhas 15 broken links to planned-but-unwritten pages (out of scope)