Skip to main content
Winnerr’s product has moved faster than the public documentation. This roadmap turns the docs app into a living product surface instead of a static help center.

​
Recommendation

Yes: map the product first, but keep the mapping lightweight and immediately useful. The goal is not to document every implementation detail before publishing. The goal is to create a trustworthy information architecture that lets us update the highest-impact pages first, then keep every new product surface connected to a maintained source of truth.

​
Current state snapshot

​
Documentation map

Use this map as the north star for the docs app.

​
1. Agent and team buyer docs

These pages should help real estate professionals get value quickly.
  • Start here: quickstart, dashboard, people, deals, phone, SMS, email, tasks, notes, calendar.
  • Core workflows: speed-to-lead, sphere nurture, deal follow-up, call prep, showing follow-up, listing launch, client portal handoff.
  • Winnie guidance: what Winnie can draft, summarize, suggest, and update; what still requires agent approval.
  • Trust guidance: consent, opt-outs, call recordings, client data, and team visibility.

​
2. Admin and brokerage operator docs

These pages should help teams roll Winnerr out safely.
  • Organization setup: members, roles, agent transfers, onboarding, billing.
  • Governance: workspace isolation, permissions, audit trails, data retention, and AI approval settings.
  • Operations: lead routing, team reporting, business pipelines, templates, phone/email setup.
  • Rollout playbooks: pilot launch, team migration, training checklist, data import QA.

​
3. Developer and integration docs

These pages should help internal engineers, partners, and technical operators build confidently.
  • Local development and monorepo structure.
  • Authentication between apps/app and apps/api.
  • API reference, webhooks, Zapier, MCP, Twilio, Nylas, MLS, and storage policy.
  • Event-driven systems: outbox, workflow handlers, webhook verification, idempotency, retries, and observability.

​
4. Agent OS and Winnie docs

These pages should translate the repository’s Agent OS work into user-facing and operator-facing documentation.
  • Agent OS overview: what it is, what it is not, and how it relates to the CRM.
  • AiChangeProposal model: how agent-suggested actions become reviewable changes.
  • Memory and consent: what is remembered, why, and how users control it.
  • Guardrails: PII masking, opt-in transparency, approval gates, and workspace isolation.
  • Rollout status: what is available now, what is in private beta, and what is planned.

​
Priority plan

​
Phase 0 — Make docs navigable

  1. Add a documentation roadmap page.
  2. Expose existing developer, API, architecture, and integration pages in mint.json.
  3. Remove or hide Mintlify template pages from the public sidebar unless they are intentionally kept as authoring guidance.
  4. Add a clear audience path from the introduction page.

​
Phase 1 — Verify the product surface

  1. Walk the live app sidebar and create a page inventory by route.
  2. For each page, record: route, owner, audience, current status, screenshots needed, and source-of-truth code paths.
  3. Mark each docs page as current, needs refresh, missing, or deprecated.
  4. Prioritize pages tied to activation, revenue workflows, or support tickets.

​
Phase 2 — Rewrite high-impact docs

  1. Quickstart and onboarding.
  2. Phone, SMS, email, and communication history.
  3. People, person detail, insights, deals, and pipelines.
  4. Winnie and AI settings.
  5. Team/admin rollout.

​
Phase 3 — Build durable maintenance

  1. Add a docs freshness checklist to every major release.
  2. Require new feature PRs to include a docs decision: new page, update page, no docs needed.
  3. Keep API docs generated or checked against route contracts where possible.
  4. Run link checks before publishing.

​
Page quality standard

Every maintained docs page should answer these questions:
  • Who is this for?
  • What job does this help them complete?
  • Where is it in the app?
  • What prerequisites are required?
  • What exact steps should the user take?
  • What does Winnie do automatically, suggest, or require approval for?
  • What data, permissions, or compliance concerns apply?
  • What related pages should the user read next?

​
Near-term backlog

​
Definition of done

The documentation app is caught up when:
  • The sidebar reflects the real product, not the historical folder structure.
  • Users can find first-value workflows without knowing internal terminology.
  • Admins understand setup, governance, and rollout responsibilities.
  • Developers can find API, webhook, auth, and integration guidance from the main navigation.
  • AI and Agent OS pages explain capabilities conservatively without implying Winnie replaces the agent.
  • Every major page has an owner, freshness status, and source-of-truth reference.