Skip to content

README.md

Latest commit

 

History

History
72 lines (52 loc) · 3.02 KB

README.md

File metadata and controls

72 lines (52 loc) · 3.02 KB
Raw

Documentation Index

This folder contains project explanation, demo, governance and commercial-readiness materials for BushfireReadyGPT.

Fast Reading Path

If you only have a few minutes, read these in order:

  1. project_overview.md - what the project is and what it is not.
  2. demo_walkthrough.md - how to demonstrate the app.
  3. ../examples/cairns_campus_bushfire_report.md - what a generated report looks like.
  4. commercial_gap_assessment.md - what remains before commercial or government use.

Start Here

File Purpose
showcase_package.md Main entry point for presentation and portfolio materials. Read this first before preparing a demo.
project_overview.md Plain project explanation for someone seeing the project for the first time.
demo_walkthrough.md Step-by-step live demonstration flow. Use this when presenting the app.
showcase_checklist.md Pre-presentation checklist for setup, demo flow, exports and safety boundary.

Product And Pilot Materials

File Purpose
../examples/cairns_campus_bushfire_report.md Static sample output for GitHub and portfolio review.
pilot_pitch.md One-page pilot pitch for councils, schools or community stakeholders.
pilot_feedback_form.md Structured feedback form for a controlled stakeholder pilot.
demo_scenarios.md Written reference for the built-in demo scenarios.

Technical And Governance Materials

File Purpose
architecture.md Technical architecture, agent responsibilities and data flow.
project_reassessment.md Current project status, gaps and recommended next build order.
commercial_gap_assessment.md Commercial and government-readiness gap assessment.
commercial_readiness_checklist.md Checklist of what is done and what remains before commercial positioning.
licence_register.md Explanation of licence assumptions tracked in data_australia/licence_register.yml.
releases/v0.1.0.md Scope, highlights, validation and limitations for the first public MVP release.

Removed Redundant Docs

The older demo_guide.md and demo_script.md files were removed because their content is now covered more clearly by:

  • demo_walkthrough.md
  • showcase_package.md
  • showcase_checklist.md

Recommended Use

For an internship or coursework presentation:

  1. Read project_overview.md.
  2. Use demo_walkthrough.md during the live demo.
  3. Check showcase_checklist.md before presenting.
  4. Use project_reassessment.md to explain what is still missing before commercial use.

For a stakeholder or pilot discussion:

  1. Start with pilot_pitch.md.
  2. Demonstrate using demo_walkthrough.md.
  3. Collect feedback with pilot_feedback_form.md.
  4. Discuss maturity using commercial_gap_assessment.md.

For GitHub reviewers:

  1. Start from the root README.md.
  2. Open the sample output in examples/.
  3. Read architecture.md only if they want implementation details.
  4. Read commercial_gap_assessment.md to understand current limits.