doc(github): add guide for scope auth

npi-ai · Apr 25, 2024 · b01b9dd · b01b9dd
1 parent 674da0c
commit b01b9dd
Show file tree

Hide file tree

Showing 2 changed files with 2 additions and 2 deletions.
diff --git a/docs/pages/api-apps/github.mdx b/docs/pages/api-apps/github.mdx
@@ -12,7 +12,7 @@ The GitHub App is crafted to refine your GitHub workflow, offering efficient man
 
     ### Get Github Access Token
 
-    Follow this guide to get your GitHub access token: https://docs.github.com/en/authentication/keeping-your-account-and-data-secure/managing-your-personal-access-tokens
+    Follow this guide to get your GitHub access token: https://docs.github.com/en/authentication/keeping-your-account-and-data-secure/managing-your-personal-access-tokens. You may need to grant the `repo` scope so that NPi can access repositories on behalf of you. ([Read more about scopes](https://docs.github.com/en/apps/oauth-apps/building-oauth-apps/scopes-for-oauth-apps))
 
     ### Authorization
 

diff --git a/docs/pages/index.mdx b/docs/pages/index.mdx
@@ -59,7 +59,7 @@ Confirm server connectivity by running `npi connect test`. If you receive a `ser
 
 ### Authorize NPi to access your GitHub account
 
-Generate a new token via [GitHub Tokens Page](https://github.com/settings/tokens) for NPi, and authorize NPi's access to your GitHub account with:
+Generate a new token via [GitHub Tokens Page](https://github.com/settings/tokens) for NPi, and authorize NPi's access to your GitHub account with the following command. You may need to grant the `repo` scope so that NPi can access repositories on behalf of you. ([Read more about scopes](https://docs.github.com/en/apps/oauth-apps/building-oauth-apps/scopes-for-oauth-apps))
 
 ```sh
 npi auth github --access-token YOUR_GITHUB_ACCESS_TOKEN