Skip to content

Docs Issue Sync (gh CLI)

Use scripts/sync_docs_issues.sh to mirror actionable TODOs from documentation into GitHub Issues.

Mark issues inline in markdown with a comment marker:

<!-- GH-ISSUE: title=Fix nav for docs; labels=docs|enhancement; assignees=ChrisTutorials; complete=false -->

Fields:

  • title: Issue title (required)
  • labels: Pipe-separated labels (optional)
  • assignees: Pipe- or comma-separated usernames (optional)
  • complete: true|false (optional). If true, the script auto-closes the issue after creation/update.

Run:

  • gh auth login # once
  • bash scripts/sync_docs_issues.sh

Output:

  • A report is written to docs_site/reports/docs_issue_sync_report.md

Notes:

  • The script finds existing issues by exact title to avoid duplicates.
  • Set GH_REPO=owner/name to override auto-detection.
  • Works best on Git Bash (Windows). For PowerShell, run via Git Bash.