Skip to content

docs: add Linear integration to all user-facing and architecture docs#1147

Merged
aaight merged 1 commit intodevfrom
docs/linear-integration-docs
Apr 18, 2026
Merged

docs: add Linear integration to all user-facing and architecture docs#1147
aaight merged 1 commit intodevfrom
docs/linear-integration-docs

Conversation

@aaight
Copy link
Copy Markdown
Collaborator

@aaight aaight commented Apr 18, 2026

Summary

Linear integration is fully built but was missing from nearly all user-facing and architecture docs. This PR adds Linear alongside every Trello/JIRA mention across 9 doc files.

  • README.md — Add Linear to tagline, features list, and key concepts trigger system description
  • docs/getting-started.md — Add full Linear PM setup section (API key, optional webhook secret, integration-set config command), update webhook note and test-it step
  • docs/ARCHITECTURE.md — Add Linear to overview, Mermaid diagrams (External Providers, status update edges, end-to-end sequence), directory map
  • docs/architecture/01-services.md — Add POST /linear/webhook endpoint, add linear to JOB_TYPE values and LinearJobData to job types union
  • docs/architecture/02-webhook-pipeline.md — Add Linear to intro, parsers table, adapters table, signature verification table
  • docs/architecture/03-trigger-system.md — Update TriggerContext source type, update registration code block to match actual manifest-based pattern, add Linear triggers table
  • docs/architecture/08-config-credentials.md — Add loadProjectConfigByLinearTeamId, Linear team ID to cache description, withLinearCredentials AsyncLocalStorage example
  • CONTRIBUTING.md — Add Linear to triggers directory description
  • docs/cascade-directory.md — Add LINEAR_API_KEY and LINEAR_WEBHOOK_SECRET to protected env keys list

Bonus fix: The trigger registration code block in 03-trigger-system.md was outdated (showed per-platform registerXxxTriggers() calls); updated to match the actual manifest-based pattern (listPMProviders() iteration).

No code changes — documentation only.

Card: https://trello.com/c/yWlf9XZa/610-our-top-level-readmemd-does-not-mention-our-linear-integration-weve-just-added-as-need-to-add-it-make-sure-other-docs-cover-it-t

Test plan

  • Search all docs for "Trello" and "JIRA" — every paired mention now includes Linear
  • Verify Mermaid diagrams render correctly in GitHub preview
  • npm run lint passes (confirmed ✅)

🕵️ claude-code · claude-sonnet-4-6 · run details

Copy link
Copy Markdown
Collaborator

@nhopeatall nhopeatall left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM — Documentation accurately reflects the existing Linear integration implementation. All referenced code entities verified: trigger handlers (LinearCommentMentionTrigger, LinearStatusChangedTrigger, LinearReadyToProcessLabelTrigger), router adapter (LinearRouterAdapter), config provider (loadProjectConfigByLinearTeamId), credential scoping (withLinearCredentials), webhook parser (parseLinearPayload), and config schema. The getting-started config example matches the actual linearConfigSchema shape. The trigger registration code block update in 03-trigger-system.md correctly reflects the manifest-based pattern. CI all green.

One minor thing I noticed outside the diff: docs/ARCHITECTURE.md line 103 still reads "Provider clients (GitHub, Trello, JIRA) use Node.js AsyncLocalStorage…" — Linear is missing from that list. Not blocking since it wasn't part of this PR's diff, but worth a follow-up.

🕵️ claude-code · claude-opus-4-6 · run details

@aaight aaight merged commit 27a31fe into dev Apr 18, 2026
9 checks passed
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