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

docs: restructure documentation into organized folders #48

Merged
makiolaj merged 1 commits from feature/docs-restructure into develop 2026-02-09 13:46:10 +00:00
Conversation 0 Commits 1 Files Changed 12 +280 -220
makiolaj commented 2026-02-09 13:46:04 +00:00
Owner
Copy Link

Clean doc organization into development/, architecture/, and deployment/ folders. Removed outdated SETUP.md, updated all links.

Clean doc organization into development/, architecture/, and deployment/ folders. Removed outdated SETUP.md, updated all links.
makiolaj added 1 commit 2026-02-09 13:46:04 +00:00
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
b1ef7e43be 
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.
makiolaj merged commit 097f0f9cee into develop 2026-02-09 13:46:10 +00:00
Sign in to join this conversation.
Reviewers
No Reviewers
Labels
Clear labels
backend
Backend (Supabase/Edge Functions)
 database
Database (Schema/Migrations)
 frontend
Frontend (Nuxt/Vue)
 infrastructure
Infrastructure (Docker/Coolify)
 mvp
Required for MVP (v0.1)
 week-1
Week 1: Foundation
 week-2
Week 2: Core Inventory
 week-3
Week 3: Barcode Scanning
 week-4
Week 4: Tag System
 week-5
Week 5: PWA & Offline
 week-6
Week 6: Deployment
No Label
Milestone
No items
No Milestone
Projects
Clear projects
No project
Assignees
Clear assignees
makiolaj
No Assignees
1 Participants
Notifications
Due Date
No due date set.
Dependencies

No dependencies set.

Reference: pantry-app/pantry#48
Delete Branch "feature/docs-restructure"

Deleting a branch is permanent. Although the deleted branch may continue to exist for a short time before it actually gets removed, it CANNOT be undone in most cases. Continue?