Skip to content

docs(dev-guide): Comprehensive Hermes workflow toolkit developer guide#782

Merged
yehudarav merged 1 commit into
masterfrom
issue641
Mar 29, 2026
Merged

docs(dev-guide): Comprehensive Hermes workflow toolkit developer guide#782
yehudarav merged 1 commit into
masterfrom
issue641

Conversation

@yehudarav
Copy link
Copy Markdown
Collaborator

Summary

Replaces 12-line stub with ~350 lines of comprehensive developer documentation for the Hermes workflow toolkit:

  • Architecture & relationship to hermes library (toolkit → workflow → engine → Luigi)
  • Workflow JSON structure with parameter referencing syntax
  • Full lifecycle documentation: create → add → build → execute → compare
  • MongoDB storage schema with querying strategy
  • Group naming convention and counter mechanism
  • LSM variant differences (handler imports, expand pipeline)
  • Complete method reference tables (25+ methods organized by category)

Test plan

  • Verify page renders with mkdocs serve

🤖 Generated with Claude Code

Replaces 12-line stub with full developer documentation covering:
- Architecture: hermesWorkflowToolkit as wrapper around hermes.workflow,
  class hierarchy, relationship to Luigi engine
- Workflow JSON structure: nodes, parameter referencing, dependency syntax
- Full lifecycle: create (dynamic class resolution via pydoc.locate) →
  add to DB (idempotent, auto-naming) → build (TaskWrapper → Luigi) →
  execute (6-step pipeline) → compare (cascading search, DataFrame diff)
- MongoDB schema: document structure, parameters extraction, dictToMongoQuery
- Group naming convention: <group>_<0001> format, counter mechanism, parsing
- LSM variant: handler imports, expand → build → execute pipeline
- Complete method reference tables (creation, storage, retrieval, comparison,
  execution, templates)

Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
@yehudarav yehudarav merged commit a2edc72 into master Mar 29, 2026
@yehudarav yehudarav deleted the issue641 branch March 29, 2026 13:31
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.

1 participant