text change #13
Merged
text change #13
Conversation
This file contains 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
shaneer
approved these changes
Mar 5, 2024
packages/api/README.md
Outdated
| @@ -1,7 +1,7 @@ | |||
| # Important | |||
There was a problem hiding this comment.
Suggested change
| # Important | |
| # monday.com platform API SDK | |
| This SDK provides a simple way to interact with monday.com's GraphQL platform API, making it easier than ever to get started with our API. | |
| The SDK abstracts away the complex GraphQL queries, providing simple operations for the most common endpoints such as fetching board data, or creating items. | |
| The SDK is supported in both Node.js and browser environments, and is using the [graphql-request client](https://www.npmjs.com/package/graphql-request) under the hood. | |
| Want to make more complex queries or find out more about what our API has to offer, check out [monday.com's platform API documentation] (https://developer.monday.com/api-reference). | |
| ## Important |
packages/api/README.md
Outdated
| @@ -1,7 +1,7 @@ | |||
| # Important | |||
|
|
|||
| This will explain how to use our provided operations and their types to start working with the api | |||
| For now, all the exported types will correspond to the 2024-04 version, with no regard to the version you specify | |||
| In here you will learn how to use our provided operations and their types to start working with the api. | |||
There was a problem hiding this comment.
Suggested change
| In here you will learn how to use our provided operations and their types to start working with the api. |
packages/api/README.md
Outdated
| This will explain how to use our provided operations and their types to start working with the api | ||
| For now, all the exported types will correspond to the 2024-04 version, with no regard to the version you specify | ||
| In here you will learn how to use our provided operations and their types to start working with the api. | ||
| For now, all the exported types will correspond to the 2024-04 version, with no regard to the version you specify. |
There was a problem hiding this comment.
Suggested change
| For now, all the exported types will correspond to the 2024-04 version, with no regard to the version you specify. | |
| The SDK works only with the current API version (2024-01) | |
| Support for specifying a version will be added in the future. |
packages/api/README.md
Outdated
| This will explain how to use our provided operations and their types to start working with the api | ||
| For now, all the exported types will correspond to the 2024-04 version, with no regard to the version you specify | ||
| In here you will learn how to use our provided operations and their types to start working with the api. | ||
| For now, all the exported types will correspond to the 2024-04 version, with no regard to the version you specify. | ||
|
|
||
| If you need a different version OR When you'l want to write your own TYPED queries, you have two options: | ||
|
|
There was a problem hiding this comment.
Remove this sections altogether since I moved these deatils to the beginning:
## Monday GraphQL JS SDK
This SDK provides you with an easy way to interact with monday.com's GraphQL API.
The SDK is supported in both Node.js and browser environments, and is using the [graphql-request client](https://www.npmjs.com/package/graphql-request) under the hood.
packages/api/README.md
Outdated
| @@ -1,7 +1,7 @@ | |||
| # Important | |||
There was a problem hiding this comment.
Other than these comments just add links to our documentation anywhere it could be relevant.
Specifically impotant imo:
In the place where you mention - are you an app developer add a linnk to the apps documentaiton with a -
"Want to find out more about monday apps" or something like that
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.
No description provided.