Skip to content

docs(huntsman): Add specification for task graph design.#277

Merged
LinZhihao-723 merged 5 commits intoy-scope:mainfrom
LinZhihao-723:task-graph-doc
Jan 22, 2026
Merged

docs(huntsman): Add specification for task graph design.#277
LinZhihao-723 merged 5 commits intoy-scope:mainfrom
LinZhihao-723:task-graph-doc

Conversation

@LinZhihao-723
Copy link
Member

@LinZhihao-723 LinZhihao-723 commented Jan 22, 2026

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

  • The PR satisfies the contribution guidelines.
  • This is a breaking change and that has been indicated in the PR title, OR this isn't a
    breaking change.
  • Necessary docs have been updated, OR no docs need to be updated.

Validation performed

  • Ensure the doc can be rendered properly.
  • Ensure all workflows pass.

Summary by CodeRabbit

  • Documentation
    • Added a new "Task graph" section to developer docs describing tasks as a directed acyclic graph: task concepts, classifications, inputs/outputs, data‑flow and control‑flow dependencies, and execution scheduling rules.
    • Added a "Task graph" card/link on the developer docs index to surface the new section.

✏️ Tip: You can customize this high-level summary in your review settings.

@LinZhihao-723 LinZhihao-723 marked this pull request as ready for review January 22, 2026 19:06
@LinZhihao-723 LinZhihao-723 requested review from a team and sitaowang1998 as code owners January 22, 2026 19:06
@coderabbitai
Copy link
Contributor

coderabbitai bot commented Jan 22, 2026

Walkthrough

Adds 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

Cohort / File(s) Summary
Developer documentation updates
docs/huntsman/src/dev-docs/index.md, docs/huntsman/src/dev-docs/task-graph.md
Adds a "Task graph" grid item card to the dev-docs index and a new task-graph.md page; documents DAG-based task model, task metadata (TDL package, function name, retries), input/output/intermediate classifications, positional typed inputs/outputs, data-flow edges and fan-out, derived control-flow edges, and schedulability criteria.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~10 minutes

🚥 Pre-merge checks | ✅ 3
✅ Passed checks (3 passed)
Check name Status Explanation
Title check ✅ Passed The pull request title directly summarizes the main change: adding task graph design specification documentation.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing touches
  • 📝 Generate docstrings

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.

❤️ Share

Comment @coderabbitai help to get the list of available commands and usage tips.

Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

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

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

@LinZhihao-723 LinZhihao-723 merged commit a471faf into y-scope:main Jan 22, 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.

2 participants