|
| 1 | +# PANCAKE Folder Structure |
| 2 | +## Organized for Easy Implementation |
| 3 | + |
| 4 | +**Last Updated**: November 2025 |
| 5 | + |
| 6 | +--- |
| 7 | + |
| 8 | +## Overview |
| 9 | + |
| 10 | +The PANCAKE repository is organized into clear directories for easy navigation and implementation: |
| 11 | + |
| 12 | +``` |
| 13 | +pancake/ |
| 14 | +├── README.md # Main entry point |
| 15 | +├── ROADMAP.md # Unified 48-week roadmap |
| 16 | +├── FOLDER_STRUCTURE.md # This file |
| 17 | +├── GOVERNANCE.md # Contribution guidelines |
| 18 | +├── pancake_config.yaml # Configuration reference |
| 19 | +│ |
| 20 | +├── docs/ # Core specifications |
| 21 | +│ ├── BITE.md # Universal data format |
| 22 | +│ ├── PANCAKE.md # Core storage & AI |
| 23 | +│ ├── SIP.md # Sensor/actuator protocol |
| 24 | +│ ├── MEAL.md # Collaboration ledger |
| 25 | +│ ├── TAP.md # Vendor integration |
| 26 | +│ └── SIRUP.md # Enriched data payload |
| 27 | +│ |
| 28 | +├── sprints/ # Sprint plans (12 weeks each) |
| 29 | +│ ├── SPRINT_1_USER_AUTHENTICATION_UPGRADE.md |
| 30 | +│ ├── SPRINT_2_ENTERPRISE_MIGRATION.md |
| 31 | +│ ├── SPRINT_3_PAYMENTS.md |
| 32 | +│ └── SPRINT_4_DATA_WALLETS.md |
| 33 | +│ |
| 34 | +├── testing/ # Testing profiles |
| 35 | +│ ├── testing_EUDR.md # EUDR compliance tests |
| 36 | +│ └── testing_food_safety.md # Food safety tests |
| 37 | +│ |
| 38 | +├── strategic/ # Strategic documents |
| 39 | +│ ├── PANCAKE_WHITEPAPER_DPI.md |
| 40 | +│ ├── EU_HORIZON_GRANTS_STRATEGY.md |
| 41 | +│ ├── EU_HORIZON_GRANTS_PROPOSAL.md |
| 42 | +│ ├── OECD_AUTHENTICATION_ALIGNMENT.md |
| 43 | +│ ├── openagri_integration.md |
| 44 | +│ └── OPENAGRI_INTEGRATION_ANALYSIS.md |
| 45 | +│ |
| 46 | +├── implementation/ # POC and code |
| 47 | +│ ├── POC_Nov20_BITE_PANCAKE.ipynb |
| 48 | +│ ├── POC_README.md |
| 49 | +│ ├── SETUP_GUIDE.md |
| 50 | +│ ├── IMPLEMENTATION.md |
| 51 | +│ ├── requirements_poc.txt |
| 52 | +│ ├── setup_postgres.sh |
| 53 | +│ ├── meal.py |
| 54 | +│ ├── tap_adapter_base.py |
| 55 | +│ ├── tap_adapters.py |
| 56 | +│ ├── tap_vendors.yaml |
| 57 | +│ └── migrations/ |
| 58 | +│ └── meal_schema.sql |
| 59 | +│ |
| 60 | +├── podcast/ # Podcast series |
| 61 | +│ ├── Episode-0-Core-Narrative.md |
| 62 | +│ ├── Module-1-PANCAKE-Core-Platform.md |
| 63 | +│ ├── Module-2-BITE-Rich-Data-Exchange.md |
| 64 | +│ ├── Module-3-SIP-Sensor-Actuator-Stream.md |
| 65 | +│ ├── Module-4-MEAL-Collaboration-Persistence.md |
| 66 | +│ ├── Module-5-TAP-SIRUP-IO-System.md |
| 67 | +│ ├── Module-6-Multi-Pronged-RAG-Query-Engine.md |
| 68 | +│ ├── Module-7-EUDR-Compliance-for-Coffee.md |
| 69 | +│ ├── Module-8-FMIS-Integration-Private-Sector.md |
| 70 | +│ ├── Module-9-Governance-Community.md |
| 71 | +│ ├── Module-10-POC-Results-Road-Ahead.md |
| 72 | +│ ├── LINKEDIN_LAUNCH_POST.md |
| 73 | +│ └── PLATFORM_LAUNCH_STRATEGY.md |
| 74 | +│ |
| 75 | +└── archive/ # Historical documentation |
| 76 | + ├── CRITICAL_REVIEW_REVISED.md |
| 77 | + ├── DELIVERY_SUMMARY.md |
| 78 | + ├── DEMO_FINAL_STATUS.md |
| 79 | + ├── DEMO_READINESS.md |
| 80 | + ├── EXECUTIVE_SUMMARY.md |
| 81 | + ├── MEAL_IMPLEMENTATION_COMPLETE.md |
| 82 | + ├── MEAL_POC_COMPLETE.md |
| 83 | + ├── MOBILE_MEAL_SPEC.md |
| 84 | + ├── PGVECTOR_SUCCESS.md |
| 85 | + ├── PHASE_1_COMPLETE.md |
| 86 | + ├── PHASE_2_PLAN.md |
| 87 | + ├── POLYGLOT_TESTING_COMPLETE.md |
| 88 | + ├── SETUP_COMPLETE.md |
| 89 | + ├── TAP_MULTI_VENDOR_COMPLETE.md |
| 90 | + ├── WHITEPAPER_OUTLINE.md |
| 91 | + └── [various fix scripts] |
| 92 | +``` |
| 93 | + |
| 94 | +--- |
| 95 | + |
| 96 | +## Directory Descriptions |
| 97 | + |
| 98 | +### `/docs` - Core Specifications |
| 99 | +**Purpose**: Core technical specifications for PANCAKE components |
| 100 | + |
| 101 | +**Contents**: |
| 102 | +- `BITE.md` - Universal data format specification |
| 103 | +- `PANCAKE.md` - Core storage and AI architecture |
| 104 | +- `SIP.md` - Sensor/actuator streaming protocol |
| 105 | +- `MEAL.md` - Collaboration and audit ledger |
| 106 | +- `TAP.md` - Vendor integration framework |
| 107 | +- `SIRUP.md` - Enriched data payload concept |
| 108 | + |
| 109 | +**Audience**: Architects, developers, standards bodies |
| 110 | + |
| 111 | +--- |
| 112 | + |
| 113 | +### `/sprints` - Sprint Plans |
| 114 | +**Purpose**: Detailed 12-week sprint plans for implementation |
| 115 | + |
| 116 | +**Contents**: |
| 117 | +- `SPRINT_1_USER_AUTHENTICATION_UPGRADE.md` - Weeks 1-12 (OECD-compliant authentication) |
| 118 | +- `SPRINT_2_ENTERPRISE_MIGRATION.md` - Weeks 13-24 (Enterprise FMIS migration) |
| 119 | +- `SPRINT_3_PAYMENTS.md` - Weeks 25-36 (Digital payments integration) |
| 120 | +- `SPRINT_4_DATA_WALLETS.md` - Weeks 37-48 (Data wallets & chain of custody) |
| 121 | + |
| 122 | +**Audience**: Project managers, developers, stakeholders |
| 123 | + |
| 124 | +--- |
| 125 | + |
| 126 | +### `/testing` - Testing Profiles |
| 127 | +**Purpose**: Testing scenarios and validation criteria for specific use cases |
| 128 | + |
| 129 | +**Contents**: |
| 130 | +- `testing_EUDR.md` - EUDR compliance testing scenarios |
| 131 | +- `testing_food_safety.md` - Food safety traceability testing scenarios |
| 132 | + |
| 133 | +**Audience**: QA engineers, testers, compliance officers |
| 134 | + |
| 135 | +--- |
| 136 | + |
| 137 | +### `/strategic` - Strategic Documents |
| 138 | +**Purpose**: Business strategy, grants, and high-level planning documents |
| 139 | + |
| 140 | +**Contents**: |
| 141 | +- `PANCAKE_WHITEPAPER_DPI.md` - Business white paper |
| 142 | +- `EU_HORIZON_GRANTS_STRATEGY.md` - EU grant strategy |
| 143 | +- `EU_HORIZON_GRANTS_PROPOSAL.md` - EU grant proposal |
| 144 | +- `OECD_AUTHENTICATION_ALIGNMENT.md` - OECD compliance analysis |
| 145 | +- `openagri_integration.md` - OpenAgri integration guide |
| 146 | +- `OPENAGRI_INTEGRATION_ANALYSIS.md` - OpenAgri analysis |
| 147 | + |
| 148 | +**Audience**: Executives, grant writers, strategic planners |
| 149 | + |
| 150 | +--- |
| 151 | + |
| 152 | +### `/implementation` - POC and Code |
| 153 | +**Purpose**: Working code, POC notebooks, and implementation guides |
| 154 | + |
| 155 | +**Contents**: |
| 156 | +- `POC_Nov20_BITE_PANCAKE.ipynb` - Proof of Concept Jupyter notebook |
| 157 | +- `POC_README.md` - POC setup instructions |
| 158 | +- `SETUP_GUIDE.md` - Setup guide |
| 159 | +- `IMPLEMENTATION.md` - Implementation guide |
| 160 | +- `requirements_poc.txt` - Python dependencies |
| 161 | +- `setup_postgres.sh` - PostgreSQL setup script |
| 162 | +- `meal.py` - MEAL implementation |
| 163 | +- `tap_adapter_base.py` - TAP adapter base class |
| 164 | +- `tap_adapters.py` - TAP adapter implementations |
| 165 | +- `tap_vendors.yaml` - TAP vendor configuration |
| 166 | +- `migrations/` - Database migration scripts |
| 167 | + |
| 168 | +**Audience**: Developers, implementers |
| 169 | + |
| 170 | +--- |
| 171 | + |
| 172 | +### `/podcast` - Podcast Series |
| 173 | +**Purpose**: Complete podcast series for NotebookLM |
| 174 | + |
| 175 | +**Contents**: 11 modules covering all aspects of PANCAKE |
| 176 | + |
| 177 | +**Audience**: General audience, marketing, community |
| 178 | + |
| 179 | +--- |
| 180 | + |
| 181 | +### `/archive` - Historical Documentation |
| 182 | +**Purpose**: Old documentation and completed phase summaries |
| 183 | + |
| 184 | +**Contents**: Historical documents, completed phase summaries, old fix scripts |
| 185 | + |
| 186 | +**Audience**: Historical reference only |
| 187 | + |
| 188 | +--- |
| 189 | + |
| 190 | +## Quick Navigation Guide |
| 191 | + |
| 192 | +### For Developers Starting Implementation |
| 193 | +1. Read `README.md` for overview |
| 194 | +2. Review `ROADMAP.md` for timeline |
| 195 | +3. Check `/sprints/` for current sprint plan |
| 196 | +4. Review `/docs/` for technical specifications |
| 197 | +5. Run `/implementation/POC_Nov20_BITE_PANCAKE.ipynb` for hands-on experience |
| 198 | + |
| 199 | +### For Project Managers |
| 200 | +1. Read `ROADMAP.md` for complete timeline |
| 201 | +2. Review `/sprints/` for detailed sprint plans |
| 202 | +3. Check `/strategic/` for business context |
| 203 | +4. Review `/testing/` for validation criteria |
| 204 | + |
| 205 | +### For Architects |
| 206 | +1. Review `/docs/` for all technical specifications |
| 207 | +2. Check `/strategic/PANCAKE_WHITEPAPER_DPI.md` for design rationale |
| 208 | +3. Review `/sprints/` for implementation approach |
| 209 | + |
| 210 | +### For Contributors |
| 211 | +1. Read `GOVERNANCE.md` for contribution guidelines |
| 212 | +2. Review `ROADMAP.md` for current priorities |
| 213 | +3. Check `/sprints/` for areas needing contribution |
| 214 | +4. Review `/implementation/` for code structure |
| 215 | + |
| 216 | +--- |
| 217 | + |
| 218 | +## File Naming Conventions |
| 219 | + |
| 220 | +- **Specifications**: `COMPONENT.md` (e.g., `BITE.md`, `PANCAKE.md`) |
| 221 | +- **Sprint Plans**: `SPRINT_N_DESCRIPTION.md` (e.g., `SPRINT_1_USER_AUTHENTICATION_UPGRADE.md`) |
| 222 | +- **Testing Profiles**: `testing_USECASE.md` (e.g., `testing_EUDR.md`) |
| 223 | +- **Strategic Docs**: `DESCRIPTION.md` (e.g., `PANCAKE_WHITEPAPER_DPI.md`) |
| 224 | +- **Implementation**: Descriptive names (e.g., `POC_Nov20_BITE_PANCAKE.ipynb`) |
| 225 | + |
| 226 | +--- |
| 227 | + |
| 228 | +## Maintenance |
| 229 | + |
| 230 | +**When to Archive**: |
| 231 | +- Phase completion summaries → `/archive` |
| 232 | +- Completed phase plans → `/archive` |
| 233 | +- Old fix scripts → `/archive` |
| 234 | +- Superseded documentation → `/archive` |
| 235 | + |
| 236 | +**When to Update**: |
| 237 | +- Core specifications → `/docs` (version controlled) |
| 238 | +- Sprint plans → `/sprints` (update as sprints progress) |
| 239 | +- Roadmap → `ROADMAP.md` (update quarterly) |
| 240 | + |
| 241 | +--- |
| 242 | + |
| 243 | +**An AgStack Project | Powered by The Linux Foundation** |
| 244 | + |
0 commit comments