Skip to content

MT-22695: Add Go SDK to the Go integration guide and Guides overview#9

Open
Rabsztok wants to merge 2 commits into
mainfrom
MT-22695-go-sdk-guide
Open

MT-22695: Add Go SDK to the Go integration guide and Guides overview#9
Rabsztok wants to merge 2 commits into
mainfrom
MT-22695-go-sdk-guide

Conversation

@Rabsztok

@Rabsztok Rabsztok commented Jul 24, 2026

Copy link
Copy Markdown

Motivation

https://railsware.atlassian.net/browse/MT-22695

Changes

  • Restructure the Go integration guide to match ruby-integration.md: SDK overview with feature list, installation (go get github.com/mailtrap/mailtrap-go), minimal send example, and API-token hint; SMTP and RESTful API sections retained
  • Add a net/smtp fallback sample to the SMTP section, since the SDK is API-only
  • Add a Go SDK card to the Guides overview (after Python, before the framework cards) and drop Go from the "additional languages" sentence

How to test

  • Open the Guides overview — verify the Go SDK card appears alongside the other SDK cards
  • Open the Go integration guide — verify the SDK section, installation command, and minimal example render correctly and the SMTP/RESTful sections are still present

Summary by CodeRabbit

  • Documentation
    • Added Go to the list of officially supported SDK integrations.
    • Expanded the Go integration guide with installation requirements, SDK setup steps, and a complete working example.
    • Added a dependency-free SMTP integration example using Go’s standard library.
    • Updated SDK navigation links and reorganized REST API guidance for clearer flow.

Decisions:
- Guide restructured to match ruby-integration.md (SDK section, feature list, installation, minimal example, API-token hint); SMTP and RESTful API sections retained
- net/smtp fallback sample added to the SMTP section since the SDK is API-only; credentials (live.smtp.mailtrap.io:587, user 'api') verified against falcon's Integrations tab source
- Go card placed after Python, before the Laravel/Symfony framework cards; Go removed from the 'additional languages' sentence
@coderabbitai

coderabbitai Bot commented Jul 24, 2026

Copy link
Copy Markdown

Review Change Stack

Warning

Review limit reached

@Rabsztok, you've reached your PR review limit, so we couldn't start this review.

Next review available in: 4 minutes

Enable usage-based reviews in Billing to review now. Otherwise, wait until the next included review is available.
You're only billed for reviews past your plan's rate limits ($0.25/file).

How can I continue?

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.

To avoid repeated limits, reduce automatic review volume by pausing incremental auto-reviews earlier, using label-based review opt-in, excluding WIP or generated PR titles, or requesting reviews manually when the PR is ready. If your team needs uninterrupted high-volume reviews, an organization admin can enable usage-based reviews.

How do review limits work?

CodeRabbit enforces per-developer PR review limits for each organization. Most developers receive the normal plan review availability.

For paid Pro and Pro+ PR reviews, CodeRabbit uses adaptive limits for sustained high-volume activity. When a developer's recent PR review activity reaches the 95th percentile or higher among CodeRabbit users, additional reviews become available more gradually as earlier reviews age out of the rolling window.

Please refer docs for additional details.

Review details
⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro Plus

Run ID: efe33a91-3101-4b86-9c36-5a9494d27eef

📥 Commits

Reviewing files that changed from the base of the PR and between ceb0877 and ade1992.

📒 Files selected for processing (1)
  • guides-and-tips/sdk/go-integration.md
📝 Walkthrough

Walkthrough

The Go integration guide was expanded with SDK installation and sending instructions, a minimal API example, and a standard-library SMTP example. The Official SDKs catalog now includes Go, while the additional-language navigation list contains Elixir, Scala, and Perl.

Changes

Go integration documentation

Layer / File(s) Summary
Go SDK and SMTP guide
guides-and-tips/sdk/go-integration.md
Adds Go SDK setup requirements, installation instructions, a minimal Send example, and a net/smtp example using smtp.SendMail.
Official SDK catalog update
guides-and-tips/README.md
Adds a Go SDK card, updates card attributes, and removes Go from the additional-language navigation sentence.

Estimated code review effort: 2 (Simple) | ~10 minutes

🚥 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 clearly matches the main change: adding Go SDK documentation to the Go integration guide and Guides overview.
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.

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.

@Rabsztok
Rabsztok marked this pull request as ready for review July 24, 2026 10:15

@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 `@guides-and-tips/sdk/go-integration.md`:
- Line 125: Replace the generic “here” anchor text in the SMTP integration link
with descriptive text such as “SMTP integration guide,” while preserving the
existing destination URL.
- Around line 7-17: Update the Go integration document’s heading hierarchy: move
the page title into YAML frontmatter, remove the standalone “# Go” heading,
promote “Overview” and “Email API/SMTP for Go” to H1 headings, and format “SDK
integration,” “Installation,” “Minimal Example,” “SMTP integration,” and
“RESTful API integration” as H2 headings.
🪄 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 Plus

Run ID: fcdd6117-6e9a-4282-9b09-fba54dfd2c6c

📥 Commits

Reviewing files that changed from the base of the PR and between 1a80fd4 and ceb0877.

📒 Files selected for processing (2)
  • guides-and-tips/README.md
  • guides-and-tips/sdk/go-integration.md

Comment thread guides-and-tips/sdk/go-integration.md
Comment thread guides-and-tips/sdk/go-integration.md Outdated
Decisions:
- Only the link added by this PR is changed; the pre-existing 'here' link in the RESTful API section is left for a separate sweep
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.

1 participant