Skip to content

docs: refresh README to match converged Nylas SDK style#541

Merged
nbarraclough merged 1 commit intomainfrom
docs/readme-refresh
May 6, 2026
Merged

docs: refresh README to match converged Nylas SDK style#541
nbarraclough merged 1 commit intomainfrom
docs/readme-refresh

Conversation

@nbarraclough
Copy link
Copy Markdown
Member

Summary

  • Aligns the Ruby SDK README with the visual + structural conventions used across the official Nylas SDKs: centered HTML header with logo, badge row (gem version · codecov · downloads · MIT), dot-separated quick links, and emoji-prefixed section headers in the canonical order.
  • Removes stale v3-beta and pre-v3 dashboard links; routes readers to developer.nylas.com instead of duplicating docs locally. Adds AI agents, Security, Reference, and Other Nylas SDKs sections.
  • Adds a short Ruby-specific note in Usage explaining the tuple return convention ([data, request_id, next_cursor, headers] for list endpoints) and a pagination snippet using next_cursor + query_params: { page_token: cursor }. Verified against lib/nylas/resources/calendars.rb and lib/nylas/handler/api_operations.rb.
  • Copies diagrams/nylas-logo.png into the repo so the header renders without hotlinking.

Test plan

  • Render the README on the docs/readme-refresh branch on GitHub and confirm the centered header, badges, and quick-link row display correctly.
  • Spot-check that all developer.nylas.com links resolve.
  • Confirm no dashboard.nylas.com, /docs/v3-beta/, or info.nylas.com/apiv3betasignup references remain.
  • Confirm the pagination snippet runs end-to-end against a real grant.

🤖 Generated with Claude Code

Aligns the Ruby SDK README with the visual + structural conventions
shared across the official Nylas SDKs (centered HTML header, badge
row, dot-separated quick links, emoji-prefixed sections). Removes
stale v3-beta and pre-v3 dashboard links; cross-links heavily to
developer.nylas.com instead of duplicating content. Adds AI agents,
security, sibling-SDKs, and reference sections, plus a Ruby-specific
note on the tuple return convention and pagination via next_cursor.

Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
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 2044b69 into main May 6, 2026
8 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