Skip to content

docs: restructure README around getting started - #96

Merged
jflayhart merged 1 commit into
mainfrom
devin/1785195226-readme-cleanup
Jul 27, 2026
Merged

docs: restructure README around getting started#96
jflayhart merged 1 commit into
mainfrom
devin/1785195226-readme-cleanup

Conversation

@devin-ai-integration

@devin-ai-integration devin-ai-integration Bot commented Jul 27, 2026

Copy link
Copy Markdown
Contributor

Summary

Rewrites the top of the README so the npm page for @linqapp/sdk reads like a product page instead of a Stainless boilerplate dump.

What's new above the fold: centered header with tagline + npm/downloads/license/TS badges, an About Linq paragraph, a numbered Getting Started (get a token at dashboard.linqapp.com/api-tooling → install → send a message), Documentation, a Resources table mapping each client.* namespace to what it does, and a Webhooks section (previously the README never mentioned webhooks despite client.webhooks.unwrap shipping in the SDK):

const event = client.webhooks.unwrap(rawRequestBody, { headers: requestHeaders });
if (event.event_type === 'message.received') { ... }

Also: examples now use client.messages.create with real text parts rather than client.chats.create({ message: {} }) (the generated placeholder that sends nothing meaningful), MCP Server and Advanced Usage moved below the useful content, empty ## Frequently Asked Questions heading dropped, and Issues/License sections added. Everything below "Handling errors" is unchanged.

Verification: all README snippets were extracted into a scratch example and typechecked (tsc --noEmit), then deleted; ./scripts/lint passes (prettier, eslint, build, attw, publint).

Caveat: README.md is generator-managed. Per CONTRIBUTING, manual edits persist across generations but can conflict — worth mirroring the intro into the Stainless config if it starts fighting us.

Co-Authored-By: patrick <patrick@pdsullivan.com>
@pdsullivan pdsullivan self-assigned this Jul 27, 2026
@devin-ai-integration

devin-ai-integration Bot commented Jul 27, 2026

Copy link
Copy Markdown
Contributor Author

🤖 Devin AI Engineer

I'll be helping with this pull request! Here's what you should know:

✅ I will automatically:

  • Address comments on this PR. Add '(aside)' to your comment to have me ignore it.
  • Look at CI failures and help fix them

Note: I can only respond to comments from users who have write access to this repository.

⚙️ Control Options:

  • Disable automatic comment, CI, and merge conflict monitoring

@jflayhart jflayhart assigned jflayhart and unassigned pdsullivan Jul 27, 2026
@jflayhart
jflayhart merged commit 1c41047 into main Jul 27, 2026
5 checks passed
@jflayhart
jflayhart deleted the devin/1785195226-readme-cleanup branch July 27, 2026 23:42
@jflayhart jflayhart mentioned this pull request Jul 27, 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