Skip to content

docs: add documentation for new Jira/GitLab skills and workflows #1189

@WilliamBerryiii

Description

@WilliamBerryiii

Summary

PR #978 (#978) introduces a significant set of new Jira and GitLab integration components. This issue tracks the documentation needed to cover these new skills, agents, instructions, and prompts so users can discover and adopt them.

New Components Requiring Documentation

Jira Python CLI Skill

  • Path: .github/skills/jira/jira/
  • Commands: search, get, comments, fields, create, update, transition, comment
  • Authentication: JIRA_URL, JIRA_EMAIL, JIRA_TOKEN environment variables
  • Documentation needed: Getting-started guide, command reference, environment setup, and usage examples for each command

GitLab Python CLI Skill

  • Path: .github/skills/gitlab/gitlab/
  • Commands: mr-list, mr-get, mr-create, mr-update, mr-comment, mr-notes, pipeline-get, pipeline-run, pipeline-jobs, job-log
  • Authentication: GITLAB_URL, GITLAB_TOKEN, GITLAB_PROJECT (optional, auto-detected from git remote)
  • Features: --fields option for concise output, git remote auto-detection for project identification
  • Documentation needed: Getting-started guide, command reference, environment setup, --fields usage, and pipeline workflow examples

Jira Backlog Manager Agent

  • Path: .github/agents/jira/jira-backlog-manager.agent.md
  • Workflows: Discovery, triage, execution, single-issue operations
  • State tracking: .copilot-tracking/jira-issues/
  • Documentation needed: Agent overview, workflow descriptions, example invocations, and state file conventions

Jira PRD-to-WIT Agent

  • Path: .github/agents/jira/jira-prd-to-wit.agent.md
  • Workflow: 5-phase PRD analysis and Jira issue hierarchy planning (planning-only, no mutations)
  • Documentation needed: Agent overview, phase descriptions, input/output conventions, and example usage

Jira Instructions (5 files)

File Purpose
jira-backlog-discovery.instructions.md Discovery protocol with 3 paths: user-centric, artifact-driven, JQL-based
jira-backlog-planning.instructions.md Reference specification for planning files, field conventions, Jira command catalog
jira-backlog-triage.instructions.md Triage workflow for field recommendations and duplicate detection
jira-backlog-update.instructions.md Execution workflow consuming planning handoffs
jira-wit-planning.instructions.md PRD work item planning reference specification

Jira Prompts (4 files)

Prompt Key Inputs
jira-discover-issues.prompt.md project, documents, jql, searchTerms, includeComments, autonomy
jira-execute-backlog.prompt.md handoff (required), autonomy, dryRun
jira-prd-to-wit.prompt.md project, artifacts, autonomy
jira-triage-issues.prompt.md project, jql, maxIssues, autonomy

Collection Manifests

  • New jira and gitlab collection YAML and markdown manifests
  • Updated hve-core-all collection to include new components
  • Regenerated plugin outputs under plugins/

Documentation Scope

  1. Docs site pages — Add pages under docs/ covering the Jira and GitLab skills, agents, and prompt workflows (following existing patterns in the getting-started and customization sections)
  2. Cross-references — Ensure the new components are linked from existing index pages and navigation where appropriate
  3. Examples — Include practical usage examples and typical workflow walkthroughs for both Jira and GitLab integrations

Related

Metadata

Metadata

Assignees

No one assigned

    Labels

    documentationImprovements or additions to documentation

    Type

    No type

    Projects

    No projects

    Milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions