Skip to content

Improve onboarding docs for self-hosted setup #12

Description

@danieleforte92

Goal

Improve onboarding documentation so a new contributor can run PantryOps locally with minimal friction.

Why

Soft-launch feedback quality depends on successful first-run experience.

Scope

  • Add explicit OS-specific setup notes (Windows/macOS/Linux where relevant)
  • Clarify environment file creation and required variables
  • Add quick verification checklist (API health endpoint, frontend URL, seed status)
  • Add troubleshooting section for common setup failures

Acceptance criteria

  • Fresh clone setup path is fully documented
  • New contributor can complete setup without guessing missing steps
  • Troubleshooting section covers top 3 recurring failures

Out of scope

  • Full deployment/production guide
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions