Skip to content

Document the Context System #502

@Angelmmiguel

Description

@Angelmmiguel

Document the new context system introduced in #484 across the documentation site. The context system replaces the single-source --from-github approach with an extensible, provider-based --context flag that supports multiple source types (GitHub issues/PRs, local files, HTTPS resources) with composable context, trust filtering, and iteration tracking.

New Guide: Provide Context to Tasks

Create a new guide at src/content/docs/rover/guides/provide-context.mdx covering:

  • What context is and how it separates instructions (what to do) from context (information needed)
  • The --context flag on rover task and rover iterate
  • URI format for each provider:
    github:issue/15              # GitHub issue (current repo)
    github:pr/18                 # GitHub PR with diff
    github:owner/repo/issue/42   # Cross-repo reference
    file:./relative.md           # Local file (relative)
    file:///absolute/path.md     # Local file (absolute)
    https://example.com/doc.md   # Remote resource
    
  • Composing multiple context sources in a single command
  • Context inheritance across iterations (context carries forward and gets updated automatically)
  • Trust settings for comment filtering:
    • --context-trust-authors alice,bob — trust specific users
    • --context-trust-all-authors — trust all comment authors
    • Default behavior: comments filtered for prompt injection protection
  • Practical examples combining multiple sources

Update: Work on GitHub Issues Guide

Update src/content/docs/rover/guides/github-issues.mdx:

  • Add deprecation notice for --from-github flag
  • Show migration path: --from-github 15--context github:issue/15
  • Document --include-comments--context-trust-all-authors migration
  • Add section on GitHub PR context (github:pr/N)
  • Document cross-repo references (github:owner/repo/issue/42)
  • Update examples to show both deprecated and new syntax side by side

Update: CLI Reference

Update src/content/docs/rover/reference/cli-reference.mdx:

  • Add --context <uri> option to rover task (repeatable)
  • Add --context <uri> option to rover iterate (repeatable)
  • Add --context-trust-authors <users> option to both commands
  • Add --context-trust-all-authors option to both commands
  • Mark --from-github as deprecated with pointer to --context

Update: Iterate on Tasks Guide

Update src/content/docs/rover/guides/iterate-tasks.mdx:

  • Add section on providing additional context during iterations with --context
  • Explain context inheritance: context from previous iterations carries forward automatically
  • Show example of adding a PR review as context for a follow-up iteration:
    rover iterate 1 "Address the review feedback" --context github:pr/18

Update: Implement a New Feature Guide

Update src/content/docs/rover/guides/assign-tasks.mdx:

  • Add a section or example showing how to provide context when creating tasks
  • Show example combining a description with file and issue context:
    rover task "Implement the feature" \
      --context github:issue/15 \
      --context file:./design.md

Update: MCP Server Documentation

Check and update MCP-related docs if the MCP schema was updated with the new --context, --context-trust-authors, and --context-trust-all-authors options (per #490 deliverables: "Update MCP schema for new options").

Deliverables

  • Create new guide src/content/docs/rover/guides/provide-context.mdx with full context system documentation
  • Update github-issues.mdx with --from-github deprecation notice and migration path
  • Update cli-reference.mdx with new --context flags on task and iterate commands
  • Update iterate-tasks.mdx with context inheritance and --context usage on iterations
  • Update assign-tasks.mdx with context examples on task creation
  • Update MCP docs if schema changes apply

Metadata

Metadata

Assignees

Labels

No labels
No labels

Type

Projects

No projects

Milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions