This quickstart walks you through the core Rescue Retriever workflow: loading the Austin Animal Center dataset, applying a rescue program filter to re-rank candidates, inspecting a candidate’s per-program score breakdown, and downloading a filtered CSV shortlist. You will be ready to hand off a qualified candidate list to a program recruiter in under five minutes.Documentation Index
Fetch the complete documentation index at: https://mintlify.com/apursley2012/rescue-retriever/llms.txt
Use this file to discover all available pages before exploring further.
Open the Dashboard
Navigate to
/dashboard. Rescue Retriever loads the full Austin Animal Center dataset immediately — no login, no network request to a backend, no waiting. The candidate table defaults to sorting by best rescue score descending, so the animals with the highest composite score across all three programs appear at the top of the first page. Every column header is clickable to resort by that field.Apply a Program Filter
Click one of the four program buttons displayed at the top of the dashboard: Water Rescue, Mountain Rescue, Disaster Rescue, or All Animals.Selecting a specific program re-ranks the entire table by that program’s individual score — the breed, sex, and age criteria for that program alone determine the sort order. Animals that satisfy all three criteria for the selected program (a strict qualifier match) display a colored program badge in their row, making them easy to spot at a glance.
| Program | Preferred breeds | Preferred sex | Age window |
|---|---|---|---|
| Water Rescue | Labrador Retriever Mix, Chesapeake Bay Retriever, Newfoundland | Intact Female | 26–156 weeks |
| Mountain Rescue | German Shepherd, Alaskan Malamute, Old English Sheepdog, Siberian Husky, Rottweiler | Intact Male | 26–156 weeks |
| Disaster Rescue | Doberman Pinscher, German Shepherd, Golden Retriever, Bloodhound, Rottweiler | Intact Male | 20–300 weeks |
Review a Candidate
Click the View link in any table row to open the Candidate Detail page at
/candidates/:id.The detail page is divided into two sections:- Shelter record — the animal’s neutral intake data as recorded by Austin Animal Center: name, breed classification, color, sex, age in weeks, intake location, and coordinates. No rescue-program assumptions are applied here.
- Program score breakdown — a scored entry for every program, showing the total weighted score (0–100), and a three-item rationale list confirming or explaining each criterion: breed match, sex match, and age match.
Export Your Shortlist
Click Export CSV in the Dashboard header. Rescue Retriever generates and downloads a CSV file containing all records currently visible in the table — reflecting any active program filter, active search query, and strict-qualifier toggle.The exported file includes these columns:The
rescue_programs column lists every program the animal strictly qualifies for, separated by semicolons (e.g., mountain; disaster). The best_match_score column contains the highest single-program score for that animal. Both columns are computed at export time from the same scoring logic used by the dashboard.Search Tips
Next Steps
Dashboard Features
Learn about every control on the main dashboard — sorting, pagination, the strict-qualifier toggle, and the breed distribution chart.
Understanding Scores
A full explanation of the weighted scoring formula: how breed, sex, and age contribute points and how the 100-point cap is applied.
Program Criteria
Detailed breed lists, age windows, preferred sex, training duration, and success rates for all three rescue programs.
CSV Export Details
Column definitions, encoding rules, and guidance on opening the exported file in Excel, Google Sheets, or a database tool.