From a151980e279dc0334e8398ba4decf33fe0589e85 Mon Sep 17 00:00:00 2001 From: Stefan-J-Hanke <54064208+Stefan-J-Hanke@users.noreply.github.com> Date: Tue, 30 Nov 2021 08:33:26 +0100 Subject: [PATCH] fix: links into github documentation I was just curious to know about that `ProductHeaderValue` type and found references in this file. However the links were not 404's but also not what was originally intended. I didn't check the whole file, just these two URLs. --- docs/getting-started.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/getting-started.md b/docs/getting-started.md index 308de9e93d..ae99a35ca4 100644 --- a/docs/getting-started.md +++ b/docs/getting-started.md @@ -6,11 +6,11 @@ The easiest way to get started with Octokit is to use a plain `GitHubClient`: var client = new GitHubClient(new ProductHeaderValue("my-cool-app")); ``` -This will let you access unauthenticated GitHub APIs, but you will be subject to rate limiting (you can read more about this [here](https://developer.github.com/v3/#rate-limiting)). +This will let you access unauthenticated GitHub APIs, but you will be subject to rate limiting (you can read more about this [here](https://docs.github.com/en/rest/overview/resources-in-the-rest-api#rate-limiting)). But why do you need this `ProductHeaderValue` value? -The API will reject you if you don't provide a `User-Agent` header (more details [here](https://developer.github.com/v3/#user-agent-required)). This is also to identify applications that are accessing the API and enable GitHub to contact the application author if there are problems. So pick a name that stands out! +The API will reject you if you don't provide a `User-Agent` header (more details [here](https://docs.github.com/en/rest/overview/resources-in-the-rest-api#user-agent-required)). This is also to identify applications that are accessing the API and enable GitHub to contact the application author if there are problems. So pick a name that stands out! ### Authenticated Access