Skip to content

feat: linear integration documentation#47

Open
maxigimenez wants to merge 6 commits into
mainfrom
maxi/eng-536-documentation-update
Open

feat: linear integration documentation#47
maxigimenez wants to merge 6 commits into
mainfrom
maxi/eng-536-documentation-update

Conversation

@maxigimenez

@maxigimenez maxigimenez commented Jun 12, 2026

Copy link
Copy Markdown
Contributor

Summary

Docs for the upcoming Linear Integration 🎉

Summary by CodeRabbit

  • Documentation
    • Introduced comprehensive Linear integration guide covering workspace connection via OAuth and organization/per-project configuration.
    • Added detailed setup instructions and usage workflows for creating and linking Linear issues from test failures, with visual examples.

@coderabbitai

coderabbitai Bot commented Jun 12, 2026

Copy link
Copy Markdown

Review Change Stack

Warning

Review limit reached

@maxigimenez, we couldn't start this review because you've reached your PR review rate limit.

More reviews will be available in 50 minutes and 55 seconds. Learn how PR review limits work.

Your organization has run out of usage credits. Purchase more credits in the billing tab to continue.

⌛ How to resolve this issue?

After more reviews become available, a review can be triggered using the @coderabbitai review command as a PR comment. Alternatively, push new commits to this PR.

We recommend that you space out your commits to avoid hitting the rate limit.

🚦 How do rate limits work?

CodeRabbit enforces hourly rate limits for each developer per organization.

Our paid plans include higher PR review limits than trial, open-source, and free plans. In all cases, reviews become available again over time. During sustained high-volume PR review activity, CodeRabbit may temporarily slow when the next review becomes available.

Please see our Fair Usage Limits Policy for further information.

ℹ️ Review info
⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro

Run ID: 14848a13-8455-4d5c-8190-acbfad2eeab6

📥 Commits

Reviewing files that changed from the base of the PR and between 66a0940 and dffd90c.

📒 Files selected for processing (1)
  • resources/integrations/linear.md
📝 Walkthrough

Walkthrough

This PR adds comprehensive documentation for a new Linear integration with Currents. Four files are created or updated: the documentation table of contents is amended, and three new documentation pages are added covering the integration overview, setup procedures, and usage workflows.

Changes

Linear Integration Documentation

Layer / File(s) Summary
Integration overview and documentation structure
SUMMARY.md, resources/integrations/linear.md
TOC is updated to announce the Linear integration. The new linear.md page provides an integration overview, OAuth architecture, setup entry points, usage capabilities, and a limitations section linking to the detailed usage guide.
Setup guide and OAuth configuration
resources/integrations/linear/setup.md
Detailed setup documentation covers required prerequisites, org-level OAuth connection workflow, per-project enablement without OAuth re-authentication, and disconnect/reconnect procedures with preserved settings.
Usage guide and feature documentation
resources/integrations/linear/usage.md
Detailed usage guide explains the complete user workflow: opening the issues panel, creating new Linear issues with required/optional fields, linking existing issues with filtering, managing linked issues, and documenting one-way association behavior and constraints.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~10 minutes

Suggested reviewers

  • twk3
🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title accurately describes the main change: adding comprehensive documentation for the Linear integration, which represents the primary and only objective of this pull request.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch maxi/eng-536-documentation-update

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands and usage tips.

@maxigimenez maxigimenez marked this pull request as ready for review June 12, 2026 12:30
@maxigimenez maxigimenez requested a review from vCaisim June 12, 2026 12:30

@coderabbitai coderabbitai Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

Actionable comments posted: 2

🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

Inline comments:
In `@resources/integrations/linear.md`:
- Line 17: Fix the heading hierarchy in the Markdown: after the H1 "# Linear"
change "### Setup" and "### Usage" to H2 ("## Setup", "## Usage") and change
"#### Limitations" to H3 ("### Limitations") so headings increment by one level
at a time and comply with MD001; locate and update the lines containing the
headings "### Setup", "### Usage", and "#### Limitations".
- Around line 1-3: The frontmatter for the root-level integration page lacks the
required icon field; open resources/integrations/linear.md and add an icon entry
at the top-level frontmatter (e.g., add icon: linear-icon-or-asset-name) so the
document includes description and icon fields together in the YAML frontmatter.
🪄 Autofix (Beta)

Fix all unresolved CodeRabbit comments on this PR:

  • Push a commit to this branch (recommended)
  • Create a new PR with the fixes

ℹ️ Review info
⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro

Run ID: d6e59936-71cb-454f-a1fb-b66834d4dc11

📥 Commits

Reviewing files that changed from the base of the PR and between ad09eb3 and 66a0940.

⛔ Files ignored due to path filters (9)
  • .gitbook/assets/linear-connect.png is excluded by !**/*.png
  • .gitbook/assets/linear-create-issue.png is excluded by !**/*.png
  • .gitbook/assets/linear-created-issue.png is excluded by !**/*.png
  • .gitbook/assets/linear-icon.svg is excluded by !**/*.svg
  • .gitbook/assets/linear-issues-list.png is excluded by !**/*.png
  • .gitbook/assets/linear-link-comment.png is excluded by !**/*.png
  • .gitbook/assets/linear-link-form.png is excluded by !**/*.png
  • .gitbook/assets/linear-linked-issues-badge.png is excluded by !**/*.png
  • .gitbook/assets/linear-no-issues.png is excluded by !**/*.png
📒 Files selected for processing (4)
  • SUMMARY.md
  • resources/integrations/linear.md
  • resources/integrations/linear/setup.md
  • resources/integrations/linear/usage.md

Comment thread resources/integrations/linear.md
Comment thread resources/integrations/linear.md Outdated
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant