Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Create documentation #3

Open
32 tasks
theimerj opened this issue Jun 15, 2023 · 0 comments
Open
32 tasks

Create documentation #3

theimerj opened this issue Jun 15, 2023 · 0 comments
Assignees
Labels
documentation Improvements or additions to documentation
Milestone

Comments

@theimerj
Copy link
Contributor

theimerj commented Jun 15, 2023

Create documentation

Sections

Introduction

  • Teaser
  • Use cases
  • Super simple DAG theory

Installation

  • Require
  • Publish config and migrations
  • Configure
    • Basic configuration
    • Storage options
    • Migrations

Concepts

  • Flow handlers
    • Every step has its handler
    • Flow control
    • Step lifecycle
  • Shadow flow
    • Templates
    • Nodes
    • Edges
  • Steps
    • Edges
    • Data storage options
      • Schemaless attributes
      • On other models
      • Database
  • Fields
    • Value retrieval
    • Saving values
    • Custom fields

Contribution

  • Contribution guide

Credits

Form

  • Vitepress
    • Deploy
@theimerj theimerj added the documentation Improvements or additions to documentation label Jun 15, 2023
@theimerj theimerj added this to the v1 milestone Jun 15, 2023
@theimerj theimerj self-assigned this Jun 15, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

1 participant