Skip to content

Update content for workflows core concept page #823

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

Merged
merged 10 commits into from
Apr 29, 2025
Merged

Update content for workflows core concept page #823

merged 10 commits into from
Apr 29, 2025

Conversation

Aviatorscode2
Copy link
Contributor

@Aviatorscode2 Aviatorscode2 commented Apr 16, 2025

Summary

Adds the "Workflow" core concept page to the documentation. This page explains workflows as the central orchestration layer in Novu, describing their structure, execution, and configuration.

Key Highlights

  • Defines what a workflow is and how it functions within Novu’s architecture.
  • Covers the Workflow Editor, notification templates, step types, and filters.
  • Documents triggering mechanics (including payloads, subscribers, and job lifecycle).
  • Explains workflow status, tags, and identifiers.
  • Includes advanced features like subscriber preferences, critical workflows, and conditional logic.

Purpose

Provides a complete conceptual foundation for understanding and using workflows in Novu.

Copy link

netlify bot commented Apr 16, 2025

Deploy Preview for docs-novu ready!

Name Link
🔨 Latest commit c324128
🔍 Latest deploy log https://app.netlify.com/sites/docs-novu/deploys/680fa27a21fc0c000820a15e
😎 Deploy Preview https://deploy-preview-823--docs-novu.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

Copy link
Contributor

@DianaHackmamba DianaHackmamba left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Great edit of this content, however, this is waaaay to long for a user to read through.

  • Break this up into smaller topics.
  • Figure out if some of the content should go elsewhere. For example, Triggering workflows is definitely a task. Explaining how to view and filter the activity feed is also a task.

Also think about where content should actually be. For example, the Channel Steps topic in Building Workflows is pretty sparse, so the explanations here might fit better there. Same with basically everything else in there, including the Overview, which is where most of this content should probably be. Possibly all of it.

A concept should provide a high-level explanation of what something is and what you can do with it. Right now, there is too much detail and explanation.

@DianaHackmamba
Copy link
Contributor

Re-request review when you are done making changes. Also, please add a description to this PR.

@novuhq novuhq deleted a comment from Aviatorscode2 Apr 17, 2025
Copy link
Contributor

@DianaHackmamba DianaHackmamba left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

One very minor update, then G2G.

@scopsy scopsy merged commit 2aa7e17 into main Apr 29, 2025
4 of 5 checks passed
@scopsy scopsy deleted the workflows branch April 29, 2025 11:42
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants