updates docs based on review feedback

octokit · Aug 14, 2024 · 9ee7534 · 9ee7534
1 parent 8e463d0
commit 9ee7534
Show file tree

Hide file tree

Showing 7 changed files with 8 additions and 21 deletions.
diff --git a/docs/DESIGN.md b/docs/DESIGN.md
@@ -34,7 +34,7 @@ _These changes represent the product of code generated from [GitHub's OpenAPI](h
 ### Process flow for generation
 1. OpenAPI changes are detected from each API representation
 2. Generator creates the SDKs and ships them to their respective language repos (i.e. dotnet-sdk, go-sdk) and PRs against main
-3. Packages and/or tagged appropriately
+3. Packages are manually created and tagged appropriately
 
 ------
 
@@ -68,8 +68,7 @@ _These changes represent any external resources or libraries used by the SDKs. I
 ### Goals
 
 1. Respect the language idioms
-2. Stay away from abbreviations
-3. Use GitHub and community aware monikers and domain language 
+2. Use GitHub and community aware monikers and domain language 
     - SDK = Software Development Kit
     - GHES = GitHub Enterprise Server  
 

diff --git a/stage/dotnet/dotnet-sdk-enterprise-cloud/README.md b/stage/dotnet/dotnet-sdk-enterprise-cloud/README.md
@@ -102,9 +102,7 @@ Note that the SDK **does not yet** support authenticating as the App itself and
 
 ## Why a generated SDK?
 
-Octokit has been an integral part of GitHub’s ecosystem, offering a robust interface for interacting with GitHub’s APIs. However, as technology evolves, so should our tools. These SDKs are not just about generating code; they are about ushering in the next era of building and integrating with GitHub. By leveraging this generative approach, we will be able to provide immediate updates to models and APIs while also introducing new features to the SDK landscape.
-
-For more information, please take a moment and head over to the GitHub blog to read more about the [why's and how's behind our move to Generative SDKs](https://github.blog/news-insights/product-news/our-move-to-generated-sdks/).
+Please take a moment and head over to the GitHub blog to read more about the [why's and how's behind our move to Generative SDKs](https://github.blog/news-insights/product-news/our-move-to-generated-sdks/).
 
 ## Why .NET?
 

diff --git a/stage/dotnet/dotnet-sdk-enterprise-server/README.md b/stage/dotnet/dotnet-sdk-enterprise-server/README.md
@@ -113,9 +113,7 @@ Note that the SDK **does not yet** support authenticating as the App itself and
 
 ## Why a generated SDK?
 
-Octokit has been an integral part of GitHub’s ecosystem, offering a robust interface for interacting with GitHub’s APIs. However, as technology evolves, so should our tools. These SDKs are not just about generating code; they are about ushering in the next era of building and integrating with GitHub. By leveraging this generative approach, we will be able to provide immediate updates to models and APIs while also introducing new features to the SDK landscape.
-
-For more information, please take a moment and head over to the GitHub blog to read more about the [why's and how's behind our move to Generative SDKs](https://github.blog/news-insights/product-news/our-move-to-generated-sdks/).
+Please take a moment and head over to the GitHub blog to read more about the [why's and how's behind our move to Generative SDKs](https://github.blog/news-insights/product-news/our-move-to-generated-sdks/).
 
 ## Why .NET?
 

diff --git a/stage/dotnet/dotnet-sdk/README.md b/stage/dotnet/dotnet-sdk/README.md
@@ -102,9 +102,7 @@ Note that the SDK **does not yet** support authenticating as the App itself and
 
 ## Why a generated SDK?
 
-Octokit has been an integral part of GitHub’s ecosystem, offering a robust interface for interacting with GitHub’s APIs. However, as technology evolves, so should our tools. These SDKs are not just about generating code; they are about ushering in the next era of building and integrating with GitHub. By leveraging this generative approach, we will be able to provide immediate updates to models and APIs while also introducing new features to the SDK landscape.
-
-For more information, please take a moment and head over to the GitHub blog to read more about the [why's and how's behind our move to Generative SDKs](https://github.blog/news-insights/product-news/our-move-to-generated-sdks/).
+Please take a moment and head over to the GitHub blog to read more about the [why's and how's behind our move to Generative SDKs](https://github.blog/news-insights/product-news/our-move-to-generated-sdks/).
 
 ## Why .NET?
 

diff --git a/stage/go/go-sdk-enterprise-cloud/README.md b/stage/go/go-sdk-enterprise-cloud/README.md
@@ -87,9 +87,7 @@ Authenticating as an App installation can be done using the `WithGitHubAppAuthen
 
 ## Why a generated SDK?
 
-Octokit has been an integral part of GitHub’s ecosystem, offering a robust interface for interacting with GitHub’s APIs. However, as technology evolves, so should our tools. These SDKs are not just about generating code; they are about ushering in the next era of building and integrating with GitHub. By leveraging this generative approach, we will be able to provide immediate updates to models and APIs while also introducing new features to the SDK landscape.
-
-For more information, please take a moment and head over to the GitHub blog to read more about the [why's and how's behind our move to Generative SDKs](https://github.blog/news-insights/product-news/our-move-to-generated-sdks/).
+Please take a moment and head over to the GitHub blog to read more about the [why's and how's behind our move to Generative SDKs](https://github.blog/news-insights/product-news/our-move-to-generated-sdks/).
 
 ## Why Go?
 

diff --git a/stage/go/go-sdk-enterprise-server/README.md b/stage/go/go-sdk-enterprise-server/README.md
@@ -116,9 +116,7 @@ Authenticating as an App installation can be done using the `WithGitHubAppAuthen
 
 ## Why a generated SDK?
 
-Octokit has been an integral part of GitHub’s ecosystem, offering a robust interface for interacting with GitHub’s APIs. However, as technology evolves, so should our tools. These SDKs are not just about generating code; they are about ushering in the next era of building and integrating with GitHub. By leveraging this generative approach, we will be able to provide immediate updates to models and APIs while also introducing new features to the SDK landscape.
-
-For more information, please take a moment and head over to the GitHub blog to read more about the [why's and how's behind our move to Generative SDKs](https://github.blog/news-insights/product-news/our-move-to-generated-sdks/).
+Please take a moment and head over to the GitHub blog to read more about the [why's and how's behind our move to Generative SDKs](https://github.blog/news-insights/product-news/our-move-to-generated-sdks/).
 
 ## Why Go?
 

diff --git a/stage/go/go-sdk/README.md b/stage/go/go-sdk/README.md
@@ -87,9 +87,7 @@ Authenticating as an App installation can be done using the `WithGitHubAppAuthen
 
 ## Why a generated SDK?
 
-Octokit has been an integral part of GitHub’s ecosystem, offering a robust interface for interacting with GitHub’s APIs. However, as technology evolves, so should our tools. These SDKs are not just about generating code; they are about ushering in the next era of building and integrating with GitHub. By leveraging this generative approach, we will be able to provide immediate updates to models and APIs while also introducing new features to the SDK landscape.
-
-For more information, please take a moment and head over to the GitHub blog to read more about the [why's and how's behind our move to Generative SDKs](https://github.blog/news-insights/product-news/our-move-to-generated-sdks/).
+Please take a moment and head over to the GitHub blog to read more about the [why's and how's behind our move to Generative SDKs](https://github.blog/news-insights/product-news/our-move-to-generated-sdks/).
 
 ## Why Go?