Skip to content

Getting Started instructions are fragmented across templates, making initial setup unclear #124

@Nitya-003

Description

@Nitya-003

Steps to reproduce

  1. Open the main repository README
  2. Follow the “Getting started” section
  3. Notice that setup instructions redirect users to individual app folders without:
  • A minimal runnable example
  • A common baseline configuration
  • Clear guidance on template selection

Relevant log output

The main README should include:
- A minimal “First Run” example (e.g., one command or one simple pipeline)
- Clear guidance on which template is best for beginners
- A short checklist of prerequisites (Python version, Docker optional, API keys)

What did you expect to happen?

While exploring the Pathway AI Pipelines repository, I found that the onboarding experience for first-time users can be confusing due to getting-started instructions being spread across multiple template-specific README files.

The main repository README explains what the pipelines do very well, but it does not provide a single minimal, end-to-end setup example to help users quickly validate their environment before choosing a specific application template.

This can make it difficult for new users to understand:

  • Which template to start with
  • What the minimal system requirements are
  • How to quickly run a first pipeline locally without deep exploration

Version

.

Docker Versions (if used)

No response

OS

Linux

On which CPU architecture did you run Pathway?

x86-64

Metadata

Metadata

Assignees

No one assigned

    Labels

    bugSomething isn't working

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions