Skip to content

docs: refresh README — fix dashboard URL, drop v3-beta paths, cross-link to developer.nylas.com#728

Merged
nbarraclough merged 2 commits intomainfrom
nbarraclough/nick-barraclough/fix-readme
May 6, 2026
Merged

docs: refresh README — fix dashboard URL, drop v3-beta paths, cross-link to developer.nylas.com#728
nbarraclough merged 2 commits intomainfrom
nbarraclough/nick-barraclough/fix-readme

Conversation

@nbarraclough
Copy link
Copy Markdown
Member

Summary

  • Replaces every `dashboard.nylas.com` link with `dashboard-v3.nylas.com` (the actual prod dashboard).
  • Swaps every `/docs/v3-beta/` and `/docs/connectivity/` URL for the current `/docs/v3/*` paths — verified against the developer.nylas.com source.
  • Bumps documented Node version from 16 to 18+ to match `package.json` `engines`.
  • Surfaces newer SDK features that the README was silent on: Agent Accounts, Notetaker, large attachments, edge runtimes (linked to the matching `examples/` subfolders).
  • Adds Error handling, Runtime support, Security (vulnerability disclosure), and TypeScript-types-bundled callouts — the kinds of sections polished SDK READMEs (Stripe, Vercel) ship by default.
  • Drops the dead v3-beta signup form and the now-irrelevant v2/6.x compatibility note.
  • Tone aligned with the nylas-samples profile README.

This is intended as the first of a series — once it lands, we'll mirror the same structure across nylas-python, nylas-ruby, and nylas-java for consistency.

Test plan

  • Render the README on GitHub and confirm the badge row and quick-link row look right.
  • Click every developer.nylas.com link and confirm none 404.
  • Confirm `dashboard-v3.nylas.com` is the right canonical host (not just a redirect target).
  • Spot-check the Error handling snippet — class names match `src/models/error.ts`.
  • Confirm every `examples/` subfolder linked in the README actually exists on `main`.

🤖 Generated with Claude Code

…ink to developer.nylas.com

The README was pointing at the old dashboard.nylas.com domain and a number
of v3-beta and v2-era documentation paths that no longer exist or redirect.
Rewrites the README to:

- Fix dashboard URLs to dashboard-v3.nylas.com.
- Replace every /docs/v3-beta/* and /docs/connectivity/* link with current
  /docs/v3/* equivalents (verified against the developer.nylas.com source).
- Bump the documented Node version to 18+ to match package.json engines.
- Surface newer features (Agent Accounts, Notetaker, large attachments,
  edge runtimes) by linking the matching examples/ subfolders.
- Add Error handling, Runtime support, Security, and TypeScript-types
  callouts that polished SDK READMEs (Stripe, Vercel) ship by default.
- Match the tone of the nylas-samples profile README.

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

codecov Bot commented May 6, 2026

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 98.72%. Comparing base (68a1bdc) to head (832b4b6).

Additional details and impacted files
@@           Coverage Diff           @@
##             main     #728   +/-   ##
=======================================
  Coverage   98.72%   98.72%           
=======================================
  Files          39       39           
  Lines         860      860           
  Branches       69       69           
=======================================
  Hits          849      849           
  Misses         11       11           

☔ 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.
  • 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

@nbarraclough nbarraclough requested a review from tareeqa May 6, 2026 20:23
- Lede now uses the official tagline ("the infrastructure that powers
  communications. Integrate with Gmail, Microsoft, IMAP, Zoom, and 250+
  email, calendar, and meeting providers in 5 minutes") instead of the
  paraphrased version.
- Adds an AI agents section pointing at nylas/skills and the Nylas CLI
  MCP installer, matching the nylas-samples profile README.

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 ca893af into main May 6, 2026
10 checks passed
@tasdrake tasdrake mentioned this pull request May 8, 2026
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