Skip to content

Commit cdee2d6

Browse files
authored
Merge pull request #768 from 47degrees/fix-documentation
Fix links on documentation
2 parents 5a90c5e + f7093d9 commit cdee2d6

12 files changed

Lines changed: 21 additions & 21 deletions

File tree

microsite/docs/activity.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -110,4 +110,4 @@ As you can see, a few features of the activity endpoint are missing.
110110

111111
As a result, if you'd like to see a feature supported, feel free to create an issue and/or a pull request!
112112

113-
[activity-scala]: https://github.com/47degrees/github4s/blob/main/github4s/src/main/scala/github4s/domain/Activity.scala
113+
[activity-scala]: https://github.com/47degrees/github4s/blob/main/github4s/shared/src/main/scala/github4s/domain/Activity.scala

microsite/docs/auth.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -91,4 +91,4 @@ As you can see, a few features of the authorization endpoint are missing.
9191

9292
As a result, if you'd like to see a feature supported, feel free to create an issue and/or a pull request!
9393

94-
[auth-scala]: https://github.com/47degrees/github4s/blob/main/github4s/src/main/scala/github4s/domain/Authorization.scala
94+
[auth-scala]: https://github.com/47degrees/github4s/blob/main/github4s/shared/src/main/scala/github4s/domain/Authorization.scala

microsite/docs/docs.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -189,9 +189,9 @@ added by default.
189189

190190
[access-token]: https://github.com/settings/tokens
191191
[github-app]: https://github.com/settings/apps
192-
[access-token-scala]: https://github.com/47degrees/github4s/blob/main/github4s/src/main/scala/github4s/algebras/AccessToken.scala
193-
[access-token-scala]: https://github.com/47degrees/github4s/blob/main/github4s/src/main/scala/github4s/interpreters/StaticAccessToken.scala
194-
[cats-sync]: https://typelevel.org/cats-effect/typeclasses/sync.html
192+
[access-token-scala]: https://github.com/47degrees/github4s/blob/main/github4s/shared/src/main/scala/github4s/algebras/AccessToken.scala
193+
[access-token-scala]: https://github.com/47degrees/github4s/blob/main/github4s/shared/src/main/scala/github4s/interpreters/StaticAccessToken.scala
194+
[cats-sync]: https://typelevel.org/cats-effect/docs/typeclasses/sync.html
195195
[dispatcher]: https://typelevel.org/cats-effect/docs/std/dispatcher
196196
[http4s-client]: https://http4s.org/v0.23/client/
197197
[public-github]: https://github.com

microsite/docs/gist.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -118,4 +118,4 @@ See [the API doc](https://developer.github.com/v3/gists/#edit-a-gist) for full r
118118
As you can see, a few features of the gist endpoint are missing. As a result, if you'd like to see a
119119
feature supported, feel free to create an issue and/or a pull request!
120120

121-
[gist-scala]: https://github.com/47degrees/github4s/blob/main/github4s/src/main/scala/github4s/domain/Gist.scala
121+
[gist-scala]: https://github.com/47degrees/github4s/blob/main/github4s/shared/src/main/scala/github4s/domain/Gist.scala

microsite/docs/git_data.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -329,4 +329,4 @@ As you can see, a few features of the git data endpoint are missing.
329329

330330
As a result, if you'd like to see a feature supported, feel free to create an issue and/or a pull request!
331331

332-
[gitdata-scala]: https://github.com/47degrees/github4s/blob/main/github4s/src/main/scala/github4s/domain/GitData.scala
332+
[gitdata-scala]: https://github.com/47degrees/github4s/blob/main/github4s/shared/src/main/scala/github4s/domain/GitData.scala

microsite/docs/issue.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -159,7 +159,7 @@ Lastly, you can also search issues all across Github thanks to `searchIssues`; i
159159
arguments:
160160

161161
- a `query` string (the URL encoding is taken care of by Github4s).
162-
- a list of [SearchParam](https://github.com/47degrees/github4s/blob/main/github4s/shared/src/main/scala/github4s/free/domain/SearchParam.scala).
162+
- a list of [SearchParam](https://github.com/47degrees/github4s/blob/main/github4s/shared/src/main/scala/github4s/domain/SearchParam.scala).
163163

164164
Let's say we want to search for the Scala bugs (<https://github.com/scala/bug>) which contain
165165
the "existential" keyword in their title:
@@ -468,8 +468,8 @@ As you can see, a few features of the issue endpoint are missing.
468468

469469
As a result, if you'd like to see a feature supported, feel free to create an issue and/or a pull request!
470470

471-
[issue-scala]: https://github.com/47degrees/github4s/blob/main/github4s/src/main/scala/github4s/domain/Issue.scala
472-
[user-scala]: https://github.com/47degrees/github4s/blob/main/github4s/src/main/scala/github4s/domain/User.scala
471+
[issue-scala]: https://github.com/47degrees/github4s/blob/main/github4s/shared/src/main/scala/github4s/domain/Issue.scala
472+
[user-scala]: https://github.com/47degrees/github4s/blob/main/github4s/shared/src/main/scala/github4s/domain/User.scala
473473

474474
## Milestones
475475

microsite/docs/organization.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -82,4 +82,4 @@ As you can see, a few features of the organization endpoint are missing.
8282

8383
As a result, if you'd like to see a feature supported, feel free to create an issue and/or a pull request!
8484

85-
[user-scala]: https://github.com/47degrees/github4s/blob/main/github4s/src/main/scala/github4s/domain/User.scala
85+
[user-scala]: https://github.com/47degrees/github4s/blob/main/github4s/shared/src/main/scala/github4s/domain/User.scala

microsite/docs/project.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -66,7 +66,7 @@ The `result` on the right is the corresponding [List[Project]][project-scala].
6666

6767
See [the API doc](https://developer.github.com/v3/projects/#list-repository-projects) for full reference.
6868

69-
[project-scala]: https://github.com/47degrees/github4s/blob/main/github4s/src/main/scala/github4s/domain/Project.scala
69+
[project-scala]: https://github.com/47degrees/github4s/blob/main/github4s/shared/src/main/scala/github4s/domain/Project.scala
7070

7171

7272
### List projects
@@ -122,7 +122,7 @@ The `result` on the right is the corresponding [List[Column]][column-scala].
122122

123123
See [the API doc](https://developer.github.com/v3/projects/columns/#list-project-columns) for full reference.
124124

125-
[column-scala]: https://github.com/47degrees/github4s/blob/main/github4s/src/main/scala/github4s/domain/Project.scala
125+
[column-scala]: https://github.com/47degrees/github4s/blob/main/github4s/shared/src/main/scala/github4s/domain/Project.scala
126126

127127
### Cards
128128

@@ -152,4 +152,4 @@ The `result` on the right is the corresponding [List[Card]][card-scala].
152152

153153
See [the API doc](https://developer.github.com/v3/projects/cards/#list-project-cards) for full reference.
154154

155-
[card-scala]: https://github.com/47degrees/github4s/blob/main/github4s/src/main/scala/github4s/domain/Project.scala
155+
[card-scala]: https://github.com/47degrees/github4s/blob/main/github4s/shared/src/main/scala/github4s/domain/Project.scala

microsite/docs/pull_request.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -67,7 +67,7 @@ See [the API doc](https://developer.github.com/v3/pulls/#get-a-single-pull-reque
6767
You can list the pull requests for a repository using `list`; it takes as arguments:
6868

6969
- the repository coordinates (`owner` and `name` of the repository).
70-
- a list of [PRFilter](https://github.com/47degrees/github4s/blob/main/github4s/shared/src/main/scala/github4s/free/domain/PullRequest.scala).
70+
- a list of [PRFilter](https://github.com/47degrees/github4s/blob/main/github4s/shared/src/main/scala/github4s/domain/PullRequest.scala).
7171

7272
As an example, let's say we want the open pull requests in <https://github.com/scala/scala> sorted
7373
by popularity:
@@ -355,4 +355,4 @@ See [the API doc](https://docs.github.com/en/free-pro-team@latest/rest/reference
355355
As you can see, a few features of the pull request endpoint are missing. As a result, if you'd like
356356
to see a feature supported, feel free to create an issue and/or a pull request!
357357

358-
[pr-scala]: https://github.com/47degrees/github4s/blob/main/github4s/src/main/scala/github4s/domain/PullRequest.scala
358+
[pr-scala]: https://github.com/47degrees/github4s/blob/main/github4s/shared/src/main/scala/github4s/domain/PullRequest.scala

microsite/docs/repository.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -79,7 +79,7 @@ reference.
7979
You can globally search repositories using `searchRepos`; it takes as arguments:
8080

8181
- a `query` string (the URL encoding is taken care of by Github4s).
82-
- a list of [SearchParam](https://github.com/47degrees/github4s/blob/main/github4s/shared/src/main/scala/github4s/free/domain/SearchParam.scala).
82+
- a list of [SearchParam](https://github.com/47degrees/github4s/blob/main/github4s/shared/src/main/scala/github4s/domain/SearchParam.scala).
8383
- `pagination`: Limit and Offset for pagination.
8484

8585
To search repositories on GitHub:
@@ -597,5 +597,5 @@ As you can see, a few features of the repository endpoint are missing.
597597

598598
As a result, if you'd like to see a feature supported, feel free to create an issue and/or a pull request!
599599

600-
[repository-scala]: https://github.com/47degrees/github4s/blob/main/github4s/src/main/scala/github4s/domain/Repository.scala
601-
[user-scala]: https://github.com/47degrees/github4s/blob/main/github4s/src/main/scala/github4s/domain/User.scala
600+
[repository-scala]: https://github.com/47degrees/github4s/blob/main/github4s/shared/src/main/scala/github4s/domain/Repository.scala
601+
[user-scala]: https://github.com/47degrees/github4s/blob/main/github4s/shared/src/main/scala/github4s/domain/User.scala

0 commit comments

Comments
 (0)