docs: restructure README around getting started - #96
Merged
Conversation
Co-Authored-By: patrick <patrick@pdsullivan.com>
Contributor
Author
🤖 Devin AI EngineerI'll be helping with this pull request! Here's what you should know: ✅ I will automatically:
Note: I can only respond to comments from users who have write access to this repository. ⚙️ Control Options:
|
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Rewrites the top of the README so the npm page for
@linqapp/sdkreads 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 despiteclient.webhooks.unwrapshipping in the SDK):Also: examples now use
client.messages.createwith real text parts rather thanclient.chats.create({ message: {} })(the generated placeholder that sends nothing meaningful), MCP Server and Advanced Usage moved below the useful content, empty## Frequently Asked Questionsheading 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/lintpasses (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.