Skip to content

Commit 8617981

Browse files
fix(docs): Refactors page titles and makes API pages visible again (#320)
* refactor: Changes "Development" to "Developer" * fix(docs): Refactors page titles and makes API pages visible again * FIx “too” -> “to” typo * refactor: Refactors API section * fix: Fixes broken link to API testing page Co-authored-by: Peter Kos <pkos91@icloud.com>
1 parent 7c3cc0a commit 8617981

File tree

3 files changed

+7
-7
lines changed

3 files changed

+7
-7
lines changed

docs/api-usage.md renamed to docs/api-overview.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
---
2-
id: api-usage
3-
title: API Usage
2+
id: api-overview
3+
title: Overview
44
---
55

66
## Introduction
@@ -29,7 +29,7 @@ For example:
2929
| Update tag | `PATCH https://your-hackathon.io/manage/trackable_tags/1.json` (with body parameters) |
3030
| Delete tag | `DELETE https://your-hackathon.io/manage/trackable_tags/1.json` |
3131

32-
For a full list of endpoints, run `bin/rails routes` locally. This utility, provided by Ruby on Rails, lists all possible paths you can route too (along with their respective HTTP method).
32+
For a full list of endpoints, run `bin/rails routes` locally. This utility, provided by Ruby on Rails, lists all possible paths you can route to (along with their respective HTTP method).
3333

3434
> Note: Datatable endpoints are highly coupled to [Datatables](https://datatables.net) functionality and are not easy to use.
3535
@@ -76,7 +76,7 @@ end
7676

7777
Authentication is implemented with OAauth 2, provided by the [Doorkeeper](https://github.com/doorkeeper-gem/doorkeeper) gem. For full Doorkeeper endpoints + docs, see the [Doorkeeper wiki](https://github.com/doorkeeper-gem/doorkeeper/wiki/API-endpoint-descriptions-and-examples).
7878

79-
See the [Setup Postman/Paw for API Testing](api-setup.md) page for information on using those tools for testing the API locally.
79+
See the [Setup Postman/Paw for API Testing](api-testing-setup.md) page for information on using those tools for testing the API locally.
8080

8181
Once appropriate authentication credentials are retrieved, they should be provided on all API requests.
8282

docs/api-setup.md renamed to docs/api-testing-setup.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
---
2-
id: api-setup
3-
title: Setup Postman/Paw for API Testing
2+
id: api-testing-setup
3+
title: Testing Setup
44
---
55

66
This page will show you how to simulate API requests with [Postman](https://www.postman.com/) or [Paw](https://paw.cloud/).

website/sidebars.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@
1212
"updating-hm"
1313
],
1414
"Guides": ["running-a-hackathon", "questionnaires", "messages", "busses"],
15-
"Development": ["api"],
15+
"API": ["api-overview", "api-testing-setup"],
1616
"Getting Help": ["resources"]
1717
}
1818
}

0 commit comments

Comments
 (0)