Skip to content
This repository was archived by the owner on Jun 9, 2026. It is now read-only.

Latest commit

 

History

History
38 lines (27 loc) · 1.48 KB

File metadata and controls

38 lines (27 loc) · 1.48 KB

InsightFlow Project Guide

This repository uses the GSD planning workflow.

Start Here

  • Read .planning/PROJECT.md for the current project context.
  • Read .planning/REQUIREMENTS.md for v1 scope.
  • Read .planning/ROADMAP.md for phase structure.
  • Read .planning/STATE.md for the current project state.

Current Product

InsightFlow is an AI-native web application for searching career-related content and generating grounded structured summaries with citations and evidence snippets.

Working Rules

  • Keep answers evidence-backed and avoid overclaiming.
  • Preserve modular boundaries in the backend: API, services, retrieval, db, schemas, prompts.
  • Keep the UI minimal, readable, and focused on search and source transparency.
  • Defer social, login, recommendation, and chat features unless the roadmap changes.

Iteration Logging Requirement

  • After each identifiable round of implementation, bug fixing, refactoring, or experimentation, append a new entry to docs/iteration_log.md.
  • Each entry must include:
    • Goal
    • Changes Made
    • Why this change was made
    • Validation / test results
    • Current conclusion
    • Next step
  • The log must be append-only; do not overwrite or delete older entries when adding a new one.
  • Do not record only what changed. Each entry must also explain why the change was made and how it was validated.

Next Step

Run the Phase 1 planning workflow or start implementation from the Phase 1 task breakdown in .planning/ROADMAP.md.