Skip to content

docs: refresh README to match nylas-nodejs style#321

Merged
nbarraclough merged 3 commits into
mainfrom
docs/readme-refresh
May 6, 2026
Merged

docs: refresh README to match nylas-nodejs style#321
nbarraclough merged 3 commits into
mainfrom
docs/readme-refresh

Conversation

@nbarraclough
Copy link
Copy Markdown
Member

Summary

  • Restyles the Kotlin & Java SDK README to match the converged Nylas SDK style (centered HTML header, badge row, dot-separated quick links, emoji-prefixed canonical sections).
  • Cross-links to developer.nylas.com instead of duplicating docs; removes stale dashboard.nylas.com and /docs/v3-beta/ URLs.
  • Adds Get started, AI agents, Reference, Security, and Other Nylas SDKs sections; keeps the Java-specific SLF4J logging notes (loggers verified against com/nylas/interceptors/HttpLoggingInterceptor.kt).
  • Copies diagrams/nylas-logo.png in from nylas-nodejs so the header logo doesn't hotlink.

Test plan

  • Render the README on the PR and confirm the header centers, the logo loads, and the five quick links use · separators.
  • Spot-check linked developer.nylas.com URLs resolve.
  • Confirm the Maven Central and codecov badges render against com.nylas.sdk:nylas.

🤖 Generated with Claude Code

nbarraclough and others added 2 commits May 6, 2026 14:55
Aligns the Kotlin & Java SDK README with the converged Nylas SDK README
style: centered HTML header, badge row, dot-separated quick links, and
canonical emoji-prefixed sections. Cross-links to developer.nylas.com
instead of duplicating docs, drops stale v3-beta and dashboard URLs, and
adds AI agents, Reference, Security, and sibling-SDK sections. Keeps the
Java-specific SLF4J logging subsection.

Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
@codecov-commenter
Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 82.49%. Comparing base (18a9e9f) to head (f464c02).

Additional details and impacted files
@@            Coverage Diff            @@
##               main     #321   +/-   ##
=========================================
  Coverage     82.49%   82.49%           
  Complexity      358      358           
=========================================
  Files            38       38           
  Lines          1034     1034           
  Branches         95       95           
=========================================
  Hits            853      853           
  Misses          122      122           
  Partials         59       59           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

Copy link
Copy Markdown

@qasim-nylas qasim-nylas left a comment

Choose a reason for hiding this comment

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

LGTM 👍

@nbarraclough nbarraclough merged commit e98cc6b into main May 6, 2026
5 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.

3 participants