docs(huntsman): Add specification for task graph design.#277
docs(huntsman): Add specification for task graph design.#277LinZhihao-723 merged 5 commits intoy-scope:mainfrom
Conversation
WalkthroughAdds a new "Task graph" developer documentation page and registers it in the docs index with a grid card and toctree entry; documents Spider's task graph semantics (DAG, task metadata and classifications, data- and control-flow dependencies, and schedulability rules). Changes
Estimated code review effort🎯 2 (Simple) | ⏱️ ~10 minutes 🚥 Pre-merge checks | ✅ 3✅ Passed checks (3 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing touches
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
There was a problem hiding this comment.
Actionable comments posted: 1
🤖 Fix all issues with AI agents
In `@docs/huntsman/src/dev-docs/task-graph.md`:
- Around line 14-18: Fix the typo in the documentation bullet that currently
reads "* Other metadata such as maximum number of retires allowed." by changing
"retires" to "retries" so the line reads "* Other metadata such as maximum
number of retries allowed."; update the single occurrence of that phrase in the
task-graph documentation to correct the spelling.
🧹 Nitpick comments (1)
docs/huntsman/src/dev-docs/task-graph.md (1)
75-85: Use headings instead of emphasis for section titles.
MD036 flags these as headings; use proper heading levels for structure and consistency.♻️ Proposed fix
-**Constraints on task inputs** +##### Constraints on task inputs ... -**Constraints on task outputs** +##### Constraints on task outputs
Description
This PR adds the specification for the task graph design, which defines the glossary needed for implementation.
The implementation requirements will be added in a future PR.
Checklist
breaking change.
Validation performed
Summary by CodeRabbit
✏️ Tip: You can customize this high-level summary in your review settings.