pantry-app/pantry
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

docs: restructure documentation into organized folders
Some checks failed
Deploy to Coolify / Code Quality (pull_request) Has been cancelled
Details
Deploy to Coolify / Run Tests (pull_request) Has been cancelled
Details
Deploy to Coolify / Deploy to Development (pull_request) Has been cancelled
Details
Deploy to Coolify / Deploy to Production (pull_request) Has been cancelled
Details
Deploy to Coolify / Deploy to Test (pull_request) Has been cancelled
Details
Pull Request Checks / Validate PR (pull_request) Has been cancelled
Details

Browse Source 
Organized docs into logical subdirectories:

**New Structure:**
- docs/
  - README.md (index with quick links)
  - PROJECT_PLAN.md (root level - main roadmap)
  - development/
    - getting-started.md (5-min quickstart)
    - local-setup.md (detailed Docker Compose guide)
    - workflow.md (daily development)
    - git-workflow.md (branching strategy)
  - architecture/
    - overview.md (tech stack, design)
    - database.md (schema, RLS, migrations)
    - api.md (endpoints, functions)
  - deployment/
    - production.md (Docker, Coolify)
    - ci-cd.md (automated pipelines)

**Cleaned Up:**
- Moved DEV_SETUP.md → docs/development/local-setup.md
- Removed outdated SETUP.md (referenced old Coolify setup)
- Replaced with getting-started.md (current Docker Compose flow)
- Updated README.md links to new structure

All paths tested, no broken links.
This commit is contained in:
Pantry Lead Agent
2026-02-09 13:45:57 +00:00
parent 12bda4c08f
commit b1ef7e43be
12 changed files with 280 additions and 220 deletions
Download Patch File Download Diff File Expand all files Collapse all files

13
README.md
View File

@@ -46,12 +46,13 @@ cd pantry
## 📚 Documentation
- [**Project Plan**](docs/PROJECT_PLAN.md) — Vision, roadmap, phases
- [**Architecture**](docs/ARCHITECTURE.md) — Tech stack, data model, design decisions
- [**Database Schema**](docs/DATABASE.md) — Tables, relationships, RLS policies
- [**API Reference**](docs/API.md) — Endpoints, Supabase functions
- [**Development Guide**](docs/DEVELOPMENT.md) — Setup, workflow, conventions
- [**Deployment**](docs/DEPLOYMENT.md) — Docker, Coolify, production setup
- **[Getting Started](docs/development/getting-started.md)** — First-time setup (5 minutes)
- **[Local Setup Guide](docs/development/local-setup.md)** — Detailed Docker Compose setup
- **[Project Plan](docs/PROJECT_PLAN.md)** — Vision, roadmap, MVP phases
- **[Architecture](docs/architecture/overview.md)** — Tech stack, design decisions
- **[Database Schema](docs/architecture/database.md)** — Tables, RLS policies, migrations
- **[Development Workflow](docs/development/workflow.md)** — Git flow, conventions
- **[Full Documentation Index](docs/README.md)** — Complete docs navigation
## 🛠️ Tech Stack