From fe4fd74fda4ebbb4e56ab1cb3b813b37349d55d5 Mon Sep 17 00:00:00 2001 From: Matthieu Napoli Date: Fri, 27 Feb 2015 15:10:02 +1300 Subject: [PATCH 1/3] Rename index.md to README.md That way the page will show on github --- doc/{index.md => README.md} | 0 1 file changed, 0 insertions(+), 0 deletions(-) rename doc/{index.md => README.md} (100%) diff --git a/doc/index.md b/doc/README.md similarity index 100% rename from doc/index.md rename to doc/README.md From f25dfc576fd98ab20f8cd5dd6ff7e971066b6b27 Mon Sep 17 00:00:00 2001 From: Matthieu Napoli Date: Sat, 28 Feb 2015 16:23:06 +1300 Subject: [PATCH 2/3] Updated links to the documentation index --- README.markdown | 2 +- doc/activity.md | 2 +- doc/authorizations.md | 2 +- doc/commits.md | 2 +- doc/customize.md | 2 +- doc/enterprise.md | 2 +- doc/gists.md | 2 +- doc/issue/comments.md | 2 +- doc/issue/labels.md | 2 +- doc/issues.md | 2 +- doc/meta.md | 2 +- doc/notification.md | 2 +- doc/organization.md | 2 +- doc/organization/members.md | 2 +- doc/organization/teams.md | 2 +- doc/pull_request/comments.md | 2 +- doc/pull_requests.md | 2 +- doc/repo/assets.md | 2 +- doc/repo/contents.md | 2 +- doc/repo/releases.md | 2 +- doc/repos.md | 2 +- doc/request_any_route.md | 2 +- doc/result_pager.md | 2 +- doc/search.md | 2 +- doc/security.md | 2 +- doc/two_factor_authentication.md | 2 +- doc/users.md | 2 +- 27 files changed, 27 insertions(+), 27 deletions(-) diff --git a/README.markdown b/README.markdown index 3a8dfd544ad..d370ff79ac3 100755 --- a/README.markdown +++ b/README.markdown @@ -90,7 +90,7 @@ Using cache, the client will get cached responses if resources haven't changed s ## Documentation -See the `doc` directory for more detailed documentation. +See the [`doc` directory](doc/) for more detailed documentation. ## License diff --git a/doc/activity.md b/doc/activity.md index ca8c74bf3a1..6f1429e157d 100644 --- a/doc/activity.md +++ b/doc/activity.md @@ -1,5 +1,5 @@ ## Activity API (incomplete) -[Back to the navigation](index.md) +[Back to the navigation](README.md) Access to Starring and Watching a Repository for [non] authenticated users. Wrap [GitHub Activity API](https://developer.github.com/v3/activity/). diff --git a/doc/authorizations.md b/doc/authorizations.md index 5386c6acab5..037bca839d9 100644 --- a/doc/authorizations.md +++ b/doc/authorizations.md @@ -1,5 +1,5 @@ ## Authorizations API -[Back to the navigation](index.md) +[Back to the navigation](README.md) Creating, deleting and listing authorizations. Wraps [GitHub Authorizations API](http://developer.github.com/v3/oauth/). diff --git a/doc/commits.md b/doc/commits.md index c48ce3126f8..741af0713a2 100644 --- a/doc/commits.md +++ b/doc/commits.md @@ -1,5 +1,5 @@ ## Commits API -[Back to the navigation](index.md) +[Back to the navigation](README.md) Getting information on specific commits, the diffs they introduce, the files they've changed. Wrap [GitHub Commit API](http://developer.github.com/v3/git/commits/). diff --git a/doc/customize.md b/doc/customize.md index 0b58ee69bd5..94888056be2 100644 --- a/doc/customize.md +++ b/doc/customize.md @@ -1,5 +1,5 @@ ## Customize `php-github-api` and testing -[Back to the navigation](index.md) +[Back to the navigation](README.md) ### Configure the http client diff --git a/doc/enterprise.md b/doc/enterprise.md index 9e38f13dce6..7308d2dc1f2 100644 --- a/doc/enterprise.md +++ b/doc/enterprise.md @@ -1,5 +1,5 @@ ## Enterprise API -[Back to the navigation](index.md) +[Back to the navigation](README.md) Provides information about a GitHub Enterprise installation. Wraps [GitHub Enterprise API](http://developer.github.com/v3/enterprise/). diff --git a/doc/gists.md b/doc/gists.md index 604ee142344..168ca3629c3 100644 --- a/doc/gists.md +++ b/doc/gists.md @@ -1,5 +1,5 @@ ## Gists API -[Back to the navigation](index.md) +[Back to the navigation](README.md) Creating, editing, deleting and listing gists. Wraps [GitHub Gists API](http://developer.github.com/v3/gists/). diff --git a/doc/issue/comments.md b/doc/issue/comments.md index 511bb891c3e..632bd3459b1 100644 --- a/doc/issue/comments.md +++ b/doc/issue/comments.md @@ -1,5 +1,5 @@ ## Issues / Comments API -[Back to the "Issues API"](../issues.md) | [Back to the navigation](../index.md) +[Back to the "Issues API"](../issues.md) | [Back to the navigation](../README.md) Wraps [GitHub Issue Comments API](http://developer.github.com/v3/issues/comments/). diff --git a/doc/issue/labels.md b/doc/issue/labels.md index 797d9a50427..e0e50b87a25 100644 --- a/doc/issue/labels.md +++ b/doc/issue/labels.md @@ -1,5 +1,5 @@ ## Issues / Labels API -[Back to the "Issues API"](../issues.md) | [Back to the navigation](../index.md) +[Back to the "Issues API"](../issues.md) | [Back to the navigation](../README.md) Wraps [GitHub Issue Labels API](http://developer.github.com/v3/issues/labels/). diff --git a/doc/issues.md b/doc/issues.md index a92ade373ec..1251d078673 100644 --- a/doc/issues.md +++ b/doc/issues.md @@ -1,5 +1,5 @@ ## Issues API -[Back to the navigation](index.md) +[Back to the navigation](README.md) Listing issues, searching, editing and closing your projects issues. Wraps [GitHub Issue API](http://developer.github.com/v3/issues/). diff --git a/doc/meta.md b/doc/meta.md index adc3e437cbb..06cb7b8681f 100644 --- a/doc/meta.md +++ b/doc/meta.md @@ -1,5 +1,5 @@ ## Users API -[Back to the navigation](index.md) +[Back to the navigation](README.md) Wrap [GitHub User API](http://developer.github.com/v3/meta/). diff --git a/doc/notification.md b/doc/notification.md index e2d941ec02b..d586b364c74 100644 --- a/doc/notification.md +++ b/doc/notification.md @@ -1,5 +1,5 @@ ## Notification API -[Back to the navigation](index.md) +[Back to the navigation](README.md) Listing notifications and marking them as read. Wraps [GitHub Notification API](https://developer.github.com/v3/activity/notifications/). diff --git a/doc/organization.md b/doc/organization.md index 6763a8f845b..0bfdd299b98 100644 --- a/doc/organization.md +++ b/doc/organization.md @@ -1,5 +1,5 @@ ## Organization API -[Back to the navigation](index.md) +[Back to the navigation](README.md) Wraps [GitHub Organization API](http://developer.github.com/v3/organization/). diff --git a/doc/organization/members.md b/doc/organization/members.md index 730836da497..b22b79c6008 100644 --- a/doc/organization/members.md +++ b/doc/organization/members.md @@ -1,5 +1,5 @@ ## Organization / Members API -[Back to the "Organization API"](../organization.md) | [Back to the navigation](../index.md) +[Back to the "Organization API"](../organization.md) | [Back to the navigation](../README.md) Wraps [GitHub Organization Members API](http://developer.github.com/v3/organization/members/). diff --git a/doc/organization/teams.md b/doc/organization/teams.md index 1f932139493..7fc1c8b1075 100644 --- a/doc/organization/teams.md +++ b/doc/organization/teams.md @@ -1,5 +1,5 @@ ## Organization / Teams API -[Back to the "Organization API"](../organization.md) | [Back to the navigation](../index.md) +[Back to the "Organization API"](../organization.md) | [Back to the navigation](../README.md) Wraps [GitHub Organization Teams API](http://developer.github.com/v3/organization/teams/). diff --git a/doc/pull_request/comments.md b/doc/pull_request/comments.md index dfeb5be3333..baca6ce363e 100644 --- a/doc/pull_request/comments.md +++ b/doc/pull_request/comments.md @@ -1,5 +1,5 @@ ## Pull Requests / Review Comments API -[Back to the "Pull Requests API"](../pull_requests.md) | [Back to the navigation](../index.md) +[Back to the "Pull Requests API"](../pull_requests.md) | [Back to the navigation](../README.md) Review Comments are comments on a portion of the unified diff. These are separate from Commit Comments (which are applied directly to a commit, outside of the Pull Request view), and Issue Comments (which do not reference diff --git a/doc/pull_requests.md b/doc/pull_requests.md index 8f8ad29b7d3..2b952b35b1f 100644 --- a/doc/pull_requests.md +++ b/doc/pull_requests.md @@ -1,5 +1,5 @@ ## Pull Requests API -[Back to the navigation](index.md) +[Back to the navigation](README.md) Additional APIs: * [Review Comments](pull_request/comments.md) diff --git a/doc/repo/assets.md b/doc/repo/assets.md index 9e6ac8b8f20..3df3eae2b72 100644 --- a/doc/repo/assets.md +++ b/doc/repo/assets.md @@ -1,5 +1,5 @@ ## Repo / Releases API -[Back to the "Repos API"](../repos.md) | [Back to the navigation](../index.md) +[Back to the "Repos API"](../repos.md) | [Back to the navigation](../README.md) ### List all assets by release diff --git a/doc/repo/contents.md b/doc/repo/contents.md index 56967101ac6..56947c5e318 100644 --- a/doc/repo/contents.md +++ b/doc/repo/contents.md @@ -1,5 +1,5 @@ ## Repo / Contents API -[Back to the "Repos API"](../repos.md) | [Back to the navigation](../index.md) +[Back to the "Repos API"](../repos.md) | [Back to the navigation](../README.md) ### Get a repository's README diff --git a/doc/repo/releases.md b/doc/repo/releases.md index cfbf5721338..35478d80387 100644 --- a/doc/repo/releases.md +++ b/doc/repo/releases.md @@ -1,5 +1,5 @@ ## Repo / Releases API -[Back to the "Repos API"](../repos.md) | [Back to the navigation](../index.md) +[Back to the "Repos API"](../repos.md) | [Back to the navigation](../README.md) This Github API Endpoint is currently undocumented because it's new, but works just fine. diff --git a/doc/repos.md b/doc/repos.md index e8f35b9e586..5949dc05aaf 100644 --- a/doc/repos.md +++ b/doc/repos.md @@ -1,5 +1,5 @@ ## Repositories API -[Back to the navigation](index.md) +[Back to the navigation](README.md) Searching repositories, getting repository information and managing repository information for authenticated users. Wrap [GitHub Repo API](http://developer.github.com/v3/repos/). All methods are described on that page. diff --git a/doc/request_any_route.md b/doc/request_any_route.md index 1465ff7934d..76680fe857f 100644 --- a/doc/request_any_route.md +++ b/doc/request_any_route.md @@ -1,5 +1,5 @@ ## Request any Route -[Back to the navigation](index.md) +[Back to the navigation](README.md) The method you need does not exist yet? You can access any GitHub route by using the "get" and "post" methods. For example: diff --git a/doc/result_pager.md b/doc/result_pager.md index d9e58ff705a..1147674edcc 100644 --- a/doc/result_pager.md +++ b/doc/result_pager.md @@ -1,5 +1,5 @@ ## Result Pager -[Back to the navigation](index.md) +[Back to the navigation](README.md) ### Usage examples diff --git a/doc/search.md b/doc/search.md index 75b79640d4c..77b6eb9816d 100644 --- a/doc/search.md +++ b/doc/search.md @@ -1,5 +1,5 @@ ## Search API -[Back to the navigation](index.md) +[Back to the navigation](README.md) Searching repositories, code, issues and users. Wrap [GitHub Search API](http://developer.github.com/v3/search/). All methods are described on that page. diff --git a/doc/security.md b/doc/security.md index 4d74fcb9aa2..358bfe8abab 100644 --- a/doc/security.md +++ b/doc/security.md @@ -1,5 +1,5 @@ ## Authentication & Security -[Back to the navigation](index.md) +[Back to the navigation](README.md) Most GitHub services do not require authentication, but some do. For example the methods that allow you to change properties on Repositories and some others. Therefore this step is facultative. diff --git a/doc/two_factor_authentication.md b/doc/two_factor_authentication.md index 7270239974f..46e84e0daa5 100644 --- a/doc/two_factor_authentication.md +++ b/doc/two_factor_authentication.md @@ -1,5 +1,5 @@ ## Two factor authentication -[Back to the navigation](index.md) +[Back to the navigation](README.md) ### Raising the exception diff --git a/doc/users.md b/doc/users.md index 810226af55b..5e76343d54e 100644 --- a/doc/users.md +++ b/doc/users.md @@ -1,5 +1,5 @@ ## Users API -[Back to the navigation](index.md) +[Back to the navigation](README.md) Searching users, getting user information and managing authenticated user account information. Wrap [GitHub User API](http://developer.github.com/v3/users/). From 21184c343bc0a6e74a8d4784da00c0dc991587f0 Mon Sep 17 00:00:00 2001 From: Matthieu Napoli Date: Sat, 28 Feb 2015 16:23:23 +1300 Subject: [PATCH 3/3] Renamed the README file for consistency --- README.markdown => README.md | 0 1 file changed, 0 insertions(+), 0 deletions(-) rename README.markdown => README.md (100%) diff --git a/README.markdown b/README.md similarity index 100% rename from README.markdown rename to README.md