Skip to content

docs: document due dependencies in README#50

Draft
Copilot wants to merge 1 commit into
mainfrom
copilot/add-due-dependencies-to-readme
Draft

docs: document due dependencies in README#50
Copilot wants to merge 1 commit into
mainfrom
copilot/add-due-dependencies-to-readme

Conversation

Copy link
Copy Markdown
Contributor

Copilot AI commented May 18, 2026

PR #49 introduced task dependency gating, but README did not describe how dependency state affects task urgency or how to configure dependencies. This update adds focused documentation so users can discover and correctly use due dependencies from the main docs.

  • Feature surface update

    • Added Task Dependencies to the top-level Features list.
  • Configuration docs

    • Added Dependencies to the task Available Options table.
    • Clarified that dependencies are selected from other Task Tracker sensor entities.
  • Behavior and constraints

    • Added a dedicated Due dependencies section describing:
      • urgency clamping model (done < due_soon < due)
      • immediate re-evaluation when dependency state changes
      • circular dependency prevention
      • validation that only Task Tracker sensors are allowed
  • Example (as documented)

    #### Due dependencies
    
    Use **Dependencies** to make a task wait on other Task Tracker tasks:
    
    - A task cannot become more urgent than its least urgent dependency (`done` < `due_soon` < `due`)
    - If a dependency changes state, dependent tasks update immediately
    - Circular dependencies are blocked
    - Only Task Tracker sensors can be selected as dependencies

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