README update for packages #771

rkodev · 2025-03-13T11:39:57Z

Closes #485
Draft README update for nested packages

rkodev · 2025-03-13T11:40:52Z

packages/msgraph-sdk/README.md

@@ -1,11 +1,193 @@
-# `@microsoft/msgraph-sdk`
+# Microsoft Graph SDK for Typescript


This is a copy of the root README

I'd advise against keeping a duplicate copy - it increases the likelihood of them getting out of sync. If you do decide to keep it, all the notes I made on the root README apply ;)

primary reason is because we will not be able to get the documentation in npm if we do not have a README, @baywet what are your thoughts, should we keep this one?

@jasonjoh the problem we're trying to solve is that the package page on npm is empty. https://www.npmjs.com/package/@microsoft/msgraph-sdk-users

We could alternative maintain a template, at a central location and have a script that copies the file before npm pack.
There are some small replacements that are needed but that should be manageable. Thoughts?

@baywet I like the idea of having a template, we can copy the README from the root directory to the package msgraph-sdk but the rest of the packages can have slightly different README files, similar to the admin package

rkodev · 2025-03-13T11:41:41Z

packages/msgraph-sdk-admin/README.md

@@ -1,11 +1,80 @@
 # `@microsoft/msgraph-sdk-admin`


Should be duplicated in all the subfolders

jasonjoh · 2025-03-13T15:32:38Z

README.md

@@ -2,7 +2,8 @@

 Get started with the Microsoft Graph SDK for Typescript by integrating the [Microsoft Graph API](https://docs.microsoft.com/graph/overview) into your Typescript application!

-> **Note:** this SDK allows you to build applications using the [v1.0](https://docs.microsoft.com/graph/use-the-api#version) of Microsoft Graph. If you want to try the latest Microsoft Graph APIs.
+> **Note:** this SDK allows you to build applications using the [v1.0](https://docs.microsoft.com/graph/use-the-api#version) of Microsoft Graph. If you want to try the latest Microsoft Graph APIs, use our [beta SDK](https://github.com/microsoftgraph/msgraph-beta-sdk-typescript) instead.


Two suggestions: use the prettier [!NOTE] syntax, and combine this note with the one right after it. Having two note blocks back-to-back is jarring for the reader and increases likelihood they will skip over it ;)

Suggested change

> **Note:** this SDK allows you to build applications using the [v1.0](https://docs.microsoft.com/graph/use-the-api#version) of Microsoft Graph. If you want to try the latest Microsoft Graph APIs, use our [beta SDK](https://github.com/microsoftgraph/msgraph-beta-sdk-typescript) instead.

> [!NOTE]

> The Microsoft Graph Typescript SDK is currently in Pre-Release. This SDK allows you to build applications using the [v1.0](https://learn.microsoft.com/graph/use-the-api#version) of Microsoft Graph. If you want to try the latest Microsoft Graph APIs, use our [beta SDK](https://github.com/microsoftgraph/msgraph-beta-sdk-typescript) instead.

Also be sure to replace all docs.microsoft.com with learn.microsoft.com.

jasonjoh · 2025-03-13T15:34:29Z

README.md

@@ -2,7 +2,8 @@

 Get started with the Microsoft Graph SDK for Typescript by integrating the [Microsoft Graph API](https://docs.microsoft.com/graph/overview) into your Typescript application!

-> **Note:** this SDK allows you to build applications using the [v1.0](https://docs.microsoft.com/graph/use-the-api#version) of Microsoft Graph. If you want to try the latest Microsoft Graph APIs.
+> **Note:** this SDK allows you to build applications using the [v1.0](https://docs.microsoft.com/graph/use-the-api#version) of Microsoft Graph. If you want to try the latest Microsoft Graph APIs, use our [beta SDK](https://github.com/microsoftgraph/msgraph-beta-sdk-typescript) instead.
+
 >
 > **Note:** the Microsoft Graph Typescript SDK is currently in Pre-Release.


Suggested change

> **Note:** the Microsoft Graph Typescript SDK is currently in Pre-Release.

jasonjoh · 2025-03-13T15:42:14Z

packages/msgraph-sdk-admin/README.md

-> TODO: description
+Get started with the Microsoft Graph SDK for TypeScript by integrating the [Microsoft Graph API](https://docs.microsoft.com/graph/overview) into your TypeScript application!
+
+> **Note:** This package is a complementary package that allows you to build applications using the [v1.0](https://docs.microsoft.com/graph/use-the-api#version) of Microsoft Graph. If you want to try the latest Microsoft Graph APIs, use our [beta SDK](https://github.com/microsoftgraph/msgraph-beta-sdk-typescript) instead.


Again, I recommend using the [!NOTE] syntax for your quote blocks. I'd also avoid using potentially confusing words like complementary - I think you're saying that it complements the main SDK, is that right? If so, I'd combine this with the note block you have a few lines down and simplify the language. Something like:

Suggested change

> **Note:** This package is a complementary package that allows you to build applications using the [v1.0](https://docs.microsoft.com/graph/use-the-api#version) of Microsoft Graph. If you want to try the latest Microsoft Graph APIs, use our [beta SDK](https://github.com/microsoftgraph/msgraph-beta-sdk-typescript) instead.

> [!NOTE]

> This package requires the `@microsoft/msgraph-sdk` package. It allows you to build applications using the [v1.0](https://learn.microsoft.com/graph/use-the-api#version) of Microsoft Graph. If you want to try the latest Microsoft Graph APIs, use our [beta SDK](https://github.com/microsoftgraph/msgraph-beta-sdk-typescript) instead.

jasonjoh · 2025-03-13T15:42:53Z

packages/msgraph-sdk-admin/README.md

+
+For more detailed documentation, see:
+
+* [Overview](https://docs.microsoft.com/graph/overview)


Replace docs.microsoft.com with learn.microsoft.com - this can be a global find and replace.

jasonjoh · 2025-03-13T15:45:18Z

packages/msgraph-sdk/README.md

@@ -1,11 +1,193 @@
-# `@microsoft/msgraph-sdk`
+# Microsoft Graph SDK for Typescript


I'd advise against keeping a duplicate copy - it increases the likelihood of them getting out of sync. If you do decide to keep it, all the notes I made on the root README apply ;)

baywet

I just realized that I never posted my comments...

baywet · 2025-03-13T18:23:36Z

packages/msgraph-sdk-admin/README.md

+const requestAdapter = new GraphRequestAdapter(authProvider);
+
+// Create a GraphServiceClient
+const graphServiceClient = createGraphServiceClient(requestAdapter);


I'd have expected this to demonstrate using the admin client instead in case they use this package directly.
Same thing for the import

baywet · 2025-03-13T18:25:29Z

packages/msgraph-sdk/README.md

@@ -1,11 +1,193 @@
-# `@microsoft/msgraph-sdk`
+# Microsoft Graph SDK for Typescript


@jasonjoh the problem we're trying to solve is that the package page on npm is empty. https://www.npmjs.com/package/@microsoft/msgraph-sdk-users

We could alternative maintain a template, at a central location and have a script that copies the file before npm pack.
There are some small replacements that are needed but that should be manageable. Thoughts?

Draft readme copy for packages

cd4e64e

rkodev temporarily deployed to build_test March 13, 2025 11:40 — with GitHub Actions Inactive

rkodev commented Mar 13, 2025

View reviewed changes

fix grammar

a73070f

rkodev temporarily deployed to build_test March 13, 2025 11:43 — with GitHub Actions Inactive

jasonjoh suggested changes Mar 13, 2025

View reviewed changes

update readme

b7f6048

rkodev temporarily deployed to build_test March 14, 2025 01:39 — with GitHub Actions Inactive

rkodev marked this pull request as ready for review March 19, 2025 12:56

rkodev requested a review from a team as a code owner March 19, 2025 12:56

Merge branch 'main' into feat/adds-readme

91923fc

rkodev temporarily deployed to build_test March 19, 2025 12:57 — with GitHub Actions Inactive

baywet reviewed Mar 19, 2025

View reviewed changes

rkodev changed the title ~~Draft README update for packages~~ EADME update for packages Mar 19, 2025

rkodev changed the title ~~EADME update for packages~~ README update for packages Mar 19, 2025

Update nested readme

dd0e70e

rkodev temporarily deployed to build_test March 20, 2025 13:04 — with GitHub Actions Inactive

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

README update for packages #771

README update for packages #771

rkodev commented Mar 13, 2025 •

edited

Loading

rkodev Mar 13, 2025

jasonjoh Mar 13, 2025

rkodev Mar 13, 2025

baywet Mar 13, 2025

rkodev Mar 20, 2025

rkodev Mar 13, 2025

jasonjoh Mar 13, 2025

jasonjoh Mar 13, 2025

jasonjoh Mar 13, 2025

jasonjoh Mar 13, 2025

jasonjoh Mar 13, 2025

jasonjoh Mar 13, 2025

baywet left a comment

baywet Mar 13, 2025

baywet Mar 13, 2025

		@@ -1,11 +1,193 @@
		# `@microsoft/msgraph-sdk`
		# Microsoft Graph SDK for Typescript

	> Note: this SDK allows you to build applications using the [v1.0](https://docs.microsoft.com/graph/use-the-api#version) of Microsoft Graph. If you want to try the latest Microsoft Graph APIs, use our [beta SDK](https://github.com/microsoftgraph/msgraph-beta-sdk-typescript) instead.
	> [!NOTE]
	> The Microsoft Graph Typescript SDK is currently in Pre-Release. This SDK allows you to build applications using the [v1.0](https://learn.microsoft.com/graph/use-the-api#version) of Microsoft Graph. If you want to try the latest Microsoft Graph APIs, use our [beta SDK](https://github.com/microsoftgraph/msgraph-beta-sdk-typescript) instead.

	> Note: This package is a complementary package that allows you to build applications using the [v1.0](https://docs.microsoft.com/graph/use-the-api#version) of Microsoft Graph. If you want to try the latest Microsoft Graph APIs, use our [beta SDK](https://github.com/microsoftgraph/msgraph-beta-sdk-typescript) instead.
	> [!NOTE]
	> This package requires the `@microsoft/msgraph-sdk` package. It allows you to build applications using the [v1.0](https://learn.microsoft.com/graph/use-the-api#version) of Microsoft Graph. If you want to try the latest Microsoft Graph APIs, use our [beta SDK](https://github.com/microsoftgraph/msgraph-beta-sdk-typescript) instead.


		For more detailed documentation, see:

		* [Overview](https://docs.microsoft.com/graph/overview)

README update for packages #771

Are you sure you want to change the base?

README update for packages #771

Conversation

rkodev commented Mar 13, 2025 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

baywet left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

rkodev commented Mar 13, 2025 •

edited

Loading