Skip to content

Commit f25dfc5

Browse files
mnapolimnapoli
committed
Updated links to the documentation index
1 parent fe4fd74 commit f25dfc5

27 files changed

+27
-27
lines changed

‎README.markdown

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -90,7 +90,7 @@ Using cache, the client will get cached responses if resources haven't changed s
9090

9191
## Documentation
9292

93-
See the `doc` directory for more detailed documentation.
93+
See the [`doc` directory](doc/) for more detailed documentation.
9494

9595
## License
9696

‎doc/activity.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
## Activity API (incomplete)
2-
[Back to the navigation](index.md)
2+
[Back to the navigation](README.md)
33

44
Access to Starring and Watching a Repository for [non] authenticated users.
55
Wrap [GitHub Activity API](https://developer.github.com/v3/activity/).

‎doc/authorizations.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
## Authorizations API
2-
[Back to the navigation](index.md)
2+
[Back to the navigation](README.md)
33

44
Creating, deleting and listing authorizations. Wraps [GitHub Authorizations API](http://developer.github.com/v3/oauth/).
55

‎doc/commits.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
## Commits API
2-
[Back to the navigation](index.md)
2+
[Back to the navigation](README.md)
33

44
Getting information on specific commits, the diffs they introduce, the files they've changed.
55
Wrap [GitHub Commit API](http://developer.github.com/v3/git/commits/).

‎doc/customize.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
## Customize `php-github-api` and testing
2-
[Back to the navigation](index.md)
2+
[Back to the navigation](README.md)
33

44
### Configure the http client
55

‎doc/enterprise.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
## Enterprise API
2-
[Back to the navigation](index.md)
2+
[Back to the navigation](README.md)
33

44
Provides information about a GitHub Enterprise installation. Wraps [GitHub Enterprise API](http://developer.github.com/v3/enterprise/).
55

‎doc/gists.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
## Gists API
2-
[Back to the navigation](index.md)
2+
[Back to the navigation](README.md)
33

44
Creating, editing, deleting and listing gists. Wraps [GitHub Gists API](http://developer.github.com/v3/gists/).
55

‎doc/issue/comments.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
## Issues / Comments API
2-
[Back to the "Issues API"](../issues.md) | [Back to the navigation](../index.md)
2+
[Back to the "Issues API"](../issues.md) | [Back to the navigation](../README.md)
33

44
Wraps [GitHub Issue Comments API](http://developer.github.com/v3/issues/comments/).
55

‎doc/issue/labels.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
## Issues / Labels API
2-
[Back to the "Issues API"](../issues.md) | [Back to the navigation](../index.md)
2+
[Back to the "Issues API"](../issues.md) | [Back to the navigation](../README.md)
33

44
Wraps [GitHub Issue Labels API](http://developer.github.com/v3/issues/labels/).
55

‎doc/issues.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
## Issues API
2-
[Back to the navigation](index.md)
2+
[Back to the navigation](README.md)
33

44
Listing issues, searching, editing and closing your projects issues.
55
Wraps [GitHub Issue API](http://developer.github.com/v3/issues/).

‎doc/meta.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
## Users API
2-
[Back to the navigation](index.md)
2+
[Back to the navigation](README.md)
33

44

55
Wrap [GitHub User API](http://developer.github.com/v3/meta/).

‎doc/notification.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
## Notification API
2-
[Back to the navigation](index.md)
2+
[Back to the navigation](README.md)
33

44
Listing notifications and marking them as read.
55
Wraps [GitHub Notification API](https://developer.github.com/v3/activity/notifications/).

‎doc/organization.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
## Organization API
2-
[Back to the navigation](index.md)
2+
[Back to the navigation](README.md)
33

44
Wraps [GitHub Organization API](http://developer.github.com/v3/organization/).
55

‎doc/organization/members.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
## Organization / Members API
2-
[Back to the "Organization API"](../organization.md) | [Back to the navigation](../index.md)
2+
[Back to the "Organization API"](../organization.md) | [Back to the navigation](../README.md)
33

44
Wraps [GitHub Organization Members API](http://developer.github.com/v3/organization/members/).
55

‎doc/organization/teams.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
## Organization / Teams API
2-
[Back to the "Organization API"](../organization.md) | [Back to the navigation](../index.md)
2+
[Back to the "Organization API"](../organization.md) | [Back to the navigation](../README.md)
33

44
Wraps [GitHub Organization Teams API](http://developer.github.com/v3/organization/teams/).
55

‎doc/pull_request/comments.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
## Pull Requests / Review Comments API
2-
[Back to the "Pull Requests API"](../pull_requests.md) | [Back to the navigation](../index.md)
2+
[Back to the "Pull Requests API"](../pull_requests.md) | [Back to the navigation](../README.md)
33

44
Review Comments are comments on a portion of the unified diff. These are separate from Commit Comments (which
55
are applied directly to a commit, outside of the Pull Request view), and Issue Comments (which do not reference

‎doc/pull_requests.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
## Pull Requests API
2-
[Back to the navigation](index.md)
2+
[Back to the navigation](README.md)
33

44
Additional APIs:
55
* [Review Comments](pull_request/comments.md)

‎doc/repo/assets.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
## Repo / Releases API
2-
[Back to the "Repos API"](../repos.md) | [Back to the navigation](../index.md)
2+
[Back to the "Repos API"](../repos.md) | [Back to the navigation](../README.md)
33

44
### List all assets by release
55

‎doc/repo/contents.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
## Repo / Contents API
2-
[Back to the "Repos API"](../repos.md) | [Back to the navigation](../index.md)
2+
[Back to the "Repos API"](../repos.md) | [Back to the navigation](../README.md)
33

44
### Get a repository's README
55

‎doc/repo/releases.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
## Repo / Releases API
2-
[Back to the "Repos API"](../repos.md) | [Back to the navigation](../index.md)
2+
[Back to the "Repos API"](../repos.md) | [Back to the navigation](../README.md)
33

44
This Github API Endpoint is currently undocumented because it's new, but works just fine.
55

‎doc/repos.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
## Repositories API
2-
[Back to the navigation](index.md)
2+
[Back to the navigation](README.md)
33

44
Searching repositories, getting repository information and managing repository information for authenticated users.
55
Wrap [GitHub Repo API](http://developer.github.com/v3/repos/). All methods are described on that page.

‎doc/request_any_route.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
## Request any Route
2-
[Back to the navigation](index.md)
2+
[Back to the navigation](README.md)
33

44
The method you need does not exist yet? You can access any GitHub route by using the "get" and "post" methods.
55
For example:

‎doc/result_pager.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
## Result Pager
2-
[Back to the navigation](index.md)
2+
[Back to the navigation](README.md)
33

44
### Usage examples
55

‎doc/search.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
## Search API
2-
[Back to the navigation](index.md)
2+
[Back to the navigation](README.md)
33

44
Searching repositories, code, issues and users.
55
Wrap [GitHub Search API](http://developer.github.com/v3/search/). All methods are described on that page.

‎doc/security.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
## Authentication & Security
2-
[Back to the navigation](index.md)
2+
[Back to the navigation](README.md)
33

44
Most GitHub services do not require authentication, but some do. For example the methods that allow you to change
55
properties on Repositories and some others. Therefore this step is facultative.

‎doc/two_factor_authentication.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
## Two factor authentication
2-
[Back to the navigation](index.md)
2+
[Back to the navigation](README.md)
33

44

55
### Raising the exception

‎doc/users.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
## Users API
2-
[Back to the navigation](index.md)
2+
[Back to the navigation](README.md)
33

44
Searching users, getting user information and managing authenticated user account information.
55
Wrap [GitHub User API](http://developer.github.com/v3/users/).

0 commit comments

Comments
 (0)