Skip to content

docs: add workflow scheduler section cleanly#1093

Merged
utksh1 merged 1 commit into
utksh1:mainfrom
csmdg7:docs/workflow-scheduler-clean
Jun 20, 2026
Merged

docs: add workflow scheduler section cleanly#1093
utksh1 merged 1 commit into
utksh1:mainfrom
csmdg7:docs/workflow-scheduler-clean

Conversation

@csmdg7

@csmdg7 csmdg7 commented Jun 19, 2026

Copy link
Copy Markdown
Contributor

Description

This PR introduces a comprehensive architectural overview of the asynchronous workflow automation engine inside docs/backend-architecture.md. It formally details how the backend manages task lifecycles through its WorkflowScheduler background loop. The documentation expands the baseline reference to break down:

  1. Persistence models (SQLite state management updates via aiosqlite).
  2. The continuous 5-second asynchronous evaluation tick sequence (_run_loop()).
  3. Non-blocking task handoffs and execution boundaries using asyncio.create_task().

Related Issues

Closes #864

Type of Change

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to not work as expected)
  • Documentation update

How Has This Been Tested?

  • Verified accuracy against implementation rules inside backend/secuscan/workflows.py.
  • Conducted visual inspection using the Markdown Preview tool in VS Code to ensure clean rendering of headings, bullet blocks, and info/warning callouts.
  • Cross-checked markdown linkage constraints to guarantee reference names precisely align with standard workspace structures.

Checklist

  • My code follows the code style of this project.
  • I have performed a self-review of my own code.
  • I have commented my code, particularly in hard-to-understand areas.
  • I have made corresponding changes to the documentation.
  • My changes generate no new warnings.

@utksh1 utksh1 added level:beginner 20 pts difficulty label for small beginner-friendly PRs type:docs Documentation work category bonus label area:docs Documentation or contributor guide work area:backend Backend API, database, or service work labels Jun 20, 2026

@utksh1 utksh1 left a comment

Copy link
Copy Markdown
Owner

Choose a reason for hiding this comment

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

Focused change with green checks; approving.

@utksh1 utksh1 merged commit 5d78bd4 into utksh1:main Jun 20, 2026
17 checks passed
@utksh1 utksh1 added the gssoc:approved Admin validation: approved for GSSoC scoring label Jun 20, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

area:backend Backend API, database, or service work area:docs Documentation or contributor guide work gssoc:approved Admin validation: approved for GSSoC scoring level:beginner 20 pts difficulty label for small beginner-friendly PRs type:docs Documentation work category bonus label

Projects

None yet

Development

Successfully merging this pull request may close these issues.

[DOCS] Add workflow scheduler section to backend architecture guide

2 participants