@pgflow/website v0.3.0

pgflow.dev documentation website

This is documentation website for pgflow stack, hosted at pgflow.dev.

!NOTE This project and all its components are licensed under Apache 2.0 license.

!TIP For technical information about the Astro setup, see ASTRO_README.md.

Documentation Structure

pgflow's documentation follows the Diátaxis framework, which organizes technical documentation into four distinct types, each serving a specific user need:

1. Tutorials - Learning-oriented content: "How do I get started with pgflow?"
2. How-to Guides - Problem-oriented content: "How do I deploy my flow to production?"
3. Explanations - Understanding-oriented content: "How does pgflow's retry mechanism work?"
4. References - Information-oriented content: "What options are available for flow configuration?"

When adding new documentation, consider which question the content answers:

• If it helps someone learn by doing → It's a Tutorial
• If it helps someone solve a specific problem → It's a How-to Guide
• If it helps someone understand a concept → It's an Explanation
• If it provides precise technical information → It's a Reference

For detailed documentation structure, organized sections, and implementation guidelines, see:

• CLAUDE.md - Documentation organization details and guidance for contributors
• DIATAXIS.md - Full explanation of the Diátaxis framework as applied to pgflow