Help Center Article Inventory

Inventory public help-center articles, categories, article metadata, canonical links, update signals, breadcrumbs, and support-content coverage indicators.

What It Does

This actor scans authorized public help-center URLs or supplied public HTML snapshots and produces source-backed article inventory rows. It extracts article title, canonical URL, category, subcategory, breadcrumb path, visible update signals, word count, searchable-answer evidence, support intent, issue code, risk level, and recommended cleanup action.

What It Does Not Do

• It does not bypass logins, paywalls, CAPTCHAs, access controls, or private APIs.
• It does not infer private article history, traffic, search rank, customer sentiment, or compliance status.
• It does not change source sites, private systems, or publication settings.

Example Input

{
  "startUrls": [
    "https://docs.github.com/en/authentication/securing-your-account-with-two-factor-authentication-2fa/about-two-factor-authentication",
    "https://docs.github.com/en/issues/tracking-your-work-with-issues/about-issues",
    "https://docs.github.com/en/get-started/start-your-journey/hello-world"
  ],
  "maxPages": 1,
  "maxDepth": 0,
  "includePatterns": [
    "/en/"
  ],
  "excludePatterns": [
    "/login",
    "/admin"
  ],
  "requestDelayMs": 250,
  "timeoutMs": 20000,
  "maxRecords": 10,
  "respectRobotsTxt": true,
  "redactQueryStrings": true,
  "maxChargeUsd": 10,
  "debug": false
}

Example Output

[
  {
    "actorSlug": "help-center-article-inventory",
    "runId": "schema-default-validation",
    "crawlTimestamp": "2026-07-11T00:56:45.836Z",
    "sourceUrl": "https://docs.github.com/en/authentication/securing-your-account-with-two-factor-authentication-2fa/about-two-factor-authentication",
    "pageUrl": "https://docs.github.com/en/authentication/securing-your-account-with-two-factor-authentication-2fa/about-two-factor-authentication",
    "status": "inventory-issue",
    "statusCode": 200,
    "evidence": "About two-factor authentication | category: Authentication | words: 740 | Authentication Secure your account with 2FA About 2FA About two-factor authentication Two-factor authentication (2FA) is an extra layer of security used when logging into websites ",
    "issueCode": "missing-update-signal",
    "riskLevel": "medium",
    "recommendation": "Add a visible reviewed or last-updated date so support teams can prioritize stale articles.",
    "articleTitle": "About two-factor authentication",
    "articleUrl": "https://docs.github.com/en/authentication/securing-your-account-with-two-factor-authentication-2fa/about-two-factor-authentication",
    "category": "Authentication",
    "subcategory": "Secure your account with 2FA",
    "breadcrumbPath": "Authentication > Secure your account with 2FA > About 2FA",
    "lastUpdatedText": "",
    "canonicalUrl": "https://docs.github.com/en/authentication/securing-your-account-with-two-factor-authentication-2fa/about-two-factor-authentication",
    "wordCount": 740,
    "hasSearchableAnswer": true,
    "supportIntent": "account_access"
  }
]

Output Fields

• actorSlug
• runId
• crawlTimestamp
• sourceUrl
• pageUrl
• status
• statusCode
• evidence
• issueCode
• riskLevel
• recommendation
• articleTitle
• articleUrl
• category
• subcategory
• breadcrumbPath
• lastUpdatedText
• canonicalUrl
• wordCount
• hasSearchableAnswer
• supportIntent

Pricing And Cost Controls

• Pricing model: Pay per event.
• Platform usage pass-through: OFF.
• Default max charge: $10.00.
• Events: actor-start, help-center-page-scanned, article-record-extracted, inventory-issue-emitted, and audit-report-generated.
• The runtime charges before paid dataset output and stops before output when the local max-charge guard is reached.

Reports

The actor writes SUMMARY.md, SUMMARY.json, inventory CSV, findings CSV, issues-by-severity JSON, and blocked/no-result diagnostics CSV to key-value storage when the report event is charged.

Limitations

Use public, authorized sources only. Supply source records for deterministic review runs or when a help center blocks unauthenticated crawling.