Skip to content

docs: add batch jobs quickstart guide#466

Merged
jlugao merged 1 commit into
masterfrom
docs/batch-jobs-quickstart
Jan 3, 2026
Merged

docs: add batch jobs quickstart guide#466
jlugao merged 1 commit into
masterfrom
docs/batch-jobs-quickstart

Conversation

@jlugao

@jlugao jlugao commented Jan 3, 2026

Copy link
Copy Markdown
Collaborator

Summary

  • Added comprehensive documentation for the batch jobs feature (import_jobs() method)
  • New file: docs/batch_jobs.md with complete quickstart guide
  • Updated mkdocs.yml to include the new documentation page

Changes

  • New documentation file: Created docs/batch_jobs.md covering:
    • Quick example with step-by-step instructions for importing batch jobs
    • Advanced usage with jobs_list for explicit control over job metadata
    • Explanation of automatic discovery vs explicit definition approaches
    • Job types (condition, action, job) and their differences
    • Best practices for organizing batch jobs by domain
    • Complete working examples with order processing use case
  • Updated navigation: Added "Batch Jobs" entry to Tutorial section in mkdocs.yml

Related Issue

Closes #50

Testing

  • Documentation builds successfully: poetry run poe docs-build
  • All quality checks pass: poetry run poe check-all (lint, format, typecheck, test)

Added comprehensive documentation for the batch jobs feature (import_jobs method).
The guide includes:
- Quick example with step-by-step instructions
- Advanced usage with jobs_list for explicit control
- Explanation of automatic discovery vs explicit definition
- Job types (condition, action, job)
- Best practices for organizing batch jobs

Closes #50
@jlugao jlugao merged commit 8fb567b into master Jan 3, 2026
7 checks passed
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.

add docs: batch jobs quickstart

1 participant