Skip to content

[TW-4721] docs(readme): improve getting started guide for first-time users#39

Merged
AaronDDM merged 1 commit intomainfrom
ad-TW-4721-improve-readme-getting-started
Mar 26, 2026
Merged

[TW-4721] docs(readme): improve getting started guide for first-time users#39
AaronDDM merged 1 commit intomainfrom
ad-TW-4721-improve-readme-getting-started

Conversation

@AaronDDM
Copy link
Copy Markdown
Collaborator

Summary

Rewrites the README to better explain the first-time user experience now that the setup wizard (nylas init) exists.

Changes

  • Replace flat Getting Started section with step-by-step walkthrough of the 4 wizard steps
  • Add multiple entry points for different users (wizard, API key shortcut, demo mode, adding accounts later)
  • Replace dense command table with categorized sections showing real copy-paste examples
  • Add dedicated Interfaces section explaining CLI vs TUI vs Air
  • Add AI & MCP Integration section
  • Simplify Configuration section with actionable commands
  • Improve tagline to highlight value proposition

Testing

  • Visual review of rendered markdown on GitHub

Related

  • TW-4721

…users

- Replace flat getting started section with step-by-step walkthrough of nylas init wizard
- Add multiple entry points: wizard, API key shortcut, demo mode, adding accounts later
- Replace dense command table with categorized sections showing copy-paste examples
- Add dedicated Interfaces section explaining CLI vs TUI vs Air
- Add AI & MCP Integration section
- Simplify Configuration section with actionable commands
- Improve tagline to highlight value proposition
@chatgpt-codex-connector
Copy link
Copy Markdown

You have reached your Codex usage limits for code reviews. You can see your limits in the Codex usage dashboard.

@AaronDDM AaronDDM requested a review from qasim-nylas March 26, 2026 12:46
@AaronDDM AaronDDM self-assigned this Mar 26, 2026
Copy link
Copy Markdown
Collaborator

@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 👍

@AaronDDM AaronDDM merged commit 1c8f5c5 into main Mar 26, 2026
6 checks passed
@AaronDDM AaronDDM deleted the ad-TW-4721-improve-readme-getting-started branch March 26, 2026 12:50
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