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 templates (recipes) for flows #61

Open
4 tasks
Tracked by #57
tomtitherington opened this issue Feb 21, 2024 · 0 comments
Open
4 tasks
Tracked by #57

Create templates (recipes) for flows #61

tomtitherington opened this issue Feb 21, 2024 · 0 comments
Labels
blocked: tech spec needed This needs planning and scoping out first. size: days This should only take a few days. size: unknown Not sure how long this will take. type: documentation Improvements or additions to documentation

Comments

@tomtitherington
Copy link
Contributor

tomtitherington commented Feb 21, 2024

Summary*

Ready to go (copy & paste) templates for various engagement flows. These will just be JSON files that are copied & pasted into our users' code repositories or added via npx, yarn ... etc (shadcn style).

Deliverables*

  • A dedicated page within the documentation that contains a list of templates.
  • Each template should have a name, description and category and the JSON content.
  • Allow users / developers to upload their own flow templates.
  • npm package for adding flows easily. e.g. npx crumpet add {name-of-flow}.

TBD

  • How do other (open-source) companies allow developers to write plugins? We should try to make this as simple as possible. PR? Add a new page to docs...?
  • Have a look at how Nango.dev allow additions to their templates.
  • Do we launch a template registry (recipe book) style of site? (e.g. Docker Hub where others can host their templates and pull ready-made templates) Maybe this should come a little later.

*required field.

@tomtitherington tomtitherington added type: documentation Improvements or additions to documentation blocked: tech spec needed This needs planning and scoping out first. size: days This should only take a few days. size: unknown Not sure how long this will take. labels Feb 21, 2024
@tomtitherington tomtitherington changed the title Templates (recipes) for flows Create templates (recipes) for flows Feb 21, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
blocked: tech spec needed This needs planning and scoping out first. size: days This should only take a few days. size: unknown Not sure how long this will take. type: documentation Improvements or additions to documentation
Projects
Status: 🔖 Planned
Development

No branches or pull requests

1 participant