Skip to content

Latest commit

 

History

2 Commits

Folders and files

NameName
Last commit message
Last commit date
 
 

Repository files navigation

Pantry OS Product Bible

Pantry OS is the operating system for household food management.

This folder contains the Product Bible for Pantry OS.

It is the source of truth for product, domain, architecture, data, API, UI, testing and AI decisions.

The implementation must derive from this documentation, not the opposite.


Structure

/docs
├── 00-project-charter.md
├── 01-product-vision.md
├── 02-ubiquitous-language.md
├── 03-domain-model.md
├── 04-business-rules.md
├── 05-user-flows.md
├── 06-erd.md
├── 07-data-dictionary.md
├── 08-prisma-schema.prisma
├── 09-api-contracts.md
├── 10-ui-specifications.md
├── 11-design-system.md
├── 12-testing-rules.md
├── 13-ai-rules.md
└── decisions/

Reading Order

New contributors should read the documents in the following order:

  1. 00-project-charter.md
  2. 01-product-vision.md
  3. 02-ubiquitous-language.md
  4. 03-domain-model.md
  5. 04-business-rules.md
  6. 05-user-flows.md

Then, depending on role:

  • Backend: 06-erd.md, 07-data-dictionary.md, 08-prisma-schema.prisma, 09-api-contracts.md
  • Frontend: 10-ui-specifications.md, 11-design-system.md
  • QA: 04-business-rules.md, 05-user-flows.md, 12-testing-rules.md
  • AI: 13-ai-rules.md

Documentation Status

File Status Notes
00-project-charter.md Stable v1 Lot 1
01-product-vision.md Stable v1 Lot 1
02-ubiquitous-language.md Stable v1 Lot 1
03-domain-model.md Stable v1 Lot 1
04-business-rules.md Stable v1 Lot 1
05-user-flows.md Stable v1 Lot 1
06-erd.md Draft placeholder Lot 2
07-data-dictionary.md Draft placeholder Lot 2
08-prisma-schema.prisma Draft placeholder Lot 2
09-api-contracts.md Draft placeholder Lot 3
10-ui-specifications.md Draft placeholder Lot 3
11-design-system.md Draft placeholder Lot 3
12-testing-rules.md Draft placeholder Lot 3
13-ai-rules.md Draft placeholder Lot 3
decisions/ Initial ADRs Lot 1 + Lot 4

Core Principle

Pantry OS represents the physical kitchen before trying to automate it.

The system does not pretend that digital inventory is always accurate. It models physical objects, tracks confidence, explains decisions and keeps the user in control.

About

No description, website, or topics provided.

Resources

Stars

0 stars

Watchers

0 watching

Forks

Releases

Packages

Contributors