Skip to content

Commit

Permalink
Updated docs to newest style
Browse files Browse the repository at this point in the history
  • Loading branch information
intenscia committed May 6, 2024
1 parent 85c5f44 commit 68c97ba
Show file tree
Hide file tree
Showing 5 changed files with 25 additions and 25 deletions.
6 changes: 3 additions & 3 deletions source/includes/_changelog.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,11 +4,11 @@

### Oct 1, 2023 - Adding new rate limit error ref

Beginning Jan 1st, 2024, the error ref **--parse_errorref_RATE_LIMITED_ENDPOINT** will be returned when a rate limit applies only to the endpoint being called. Error ref **--parse_errorref_RATE_LIMITED_GLOBAL** will continue to be returned in all other scenarios where the [rate limit](/#rate-limiting) applies to all endpoints.
Beginning Jan 1st, 2024, the error ref **--parse_errorref_RATE_LIMITED_ENDPOINT** will be returned when a rate limit applies only to the endpoint being called. Error ref **--parse_errorref_RATE_LIMITED_GLOBAL** will continue to be returned in all other scenarios where the [rate limit](../#rate-limiting) applies to all endpoints.

### Oct 27, 2022 - Deprecating X-Ratelimit headers

Beginning Nov 20th, 2022, all custom rate limit headers `X-RateLimit-Limit`, `X-RateLimit-Remaining`, `X-RateLimit-RetryAfter` will no longer be returned. They will be replaced with `retry-after` when the [ratelimit is exceeded](/#rate-limiting).
Beginning Nov 20th, 2022, all custom rate limit headers `X-RateLimit-Limit`, `X-RateLimit-Remaining`, `X-RateLimit-RetryAfter` will no longer be returned. They will be replaced with `retry-after` when the [ratelimit is exceeded](../#rate-limiting).

# How We Version

Expand Down Expand Up @@ -45,7 +45,7 @@ part of the URL required to make a successful request.
When making requests to the API, you need to be sure you know what functionality is available to you
and what you can expect the API to do under every situation. With that said, and in the interest of
being as explicit as possible if you supply a version in the URL of your request that is _not_ listed
in the [changelog](#api-versions) below - a `404 Not Found` will be returned in the form of the [Error Object](/#error-object).
in the [changelog](#api-versions) below - a `404 Not Found` will be returned in the form of the [Error Object](../#error-object).

## What are breaking changes

Expand Down
8 changes: 4 additions & 4 deletions source/includes/_modio.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ __API path:__ [--parse_apiurl](--parse_apiurl) (see your API access dashboard)

__Current version:__ --parse_vdropdown

<a href="/changelog"><span class="versionwrap">View Version Changelog</span></a>
<a href="changelog/"><span class="versionwrap">View Version Changelog</span></a>

## How It Works

Expand All @@ -23,7 +23,7 @@ Once you have added your game to --parse_sitename and got your [game ID and API
Option | Usage | Suited for | Docs
---------- | ---------- | ---------- | ---------
__API__ | For connecting directly to the --parse_sitename REST API. | Web apps that need a JSON REST API, or game developers that like a challenge and want control over their implementation. | You are reading them
__SDK__ | Drop our [open source C/C++ SDK](https://github.com/modio/modio-sdk) into your game to call --parse_sitename functionality. | Developers that want a SDK that abstracts the uploading, downloading and unzip flows behind easy to use function calls. | [Here](https://go.mod.io/sdk-docs)
__SDK__ | Drop our [open source C/C++ SDK](https://github.com/modio/modio-sdk) into your game to call --parse_sitename functionality. | Developers that want a SDK that abstracts the uploading, downloading and unzip flows behind easy to use function calls. | [Here](--parse_docsurl/cppsdkref/)
__Tools/Plugins__ | Use tools, plugins and wrappers created by the community to make implementation in various engines easy. | Game developers that want a pre-built modding solution for their engine (Unity, Unreal, GameMaker, Construct) of choice. | Available below

### Official Tools
Expand All @@ -32,8 +32,8 @@ Plugins and wrappers made or supported by the --parse_sitename team

| - | - | -
--- | --- | --- | ---
![Unity Plugin](images/tool-unity.png) | __Unity Plugin__<br />[SDK](https://github.com/modio/modio-unity)<br />[Getting Started](https://go.mod.io/unity-docs)<br />[Sample Project](https://go.mod.io/unity-samples)<br /> | ![Unreal Plugin](images/tool-unreal.png) | __Unreal Plugin__<br />[SDK](https://github.com/modio/modio-ue)<br />[Getting Started](https://go.mod.io/ue-docs)<br />[UE4 Sample Project](https://go.mod.io/ue-samples)<br />[UE5 Sample Project](https://go.mod.io/ue5-sample)<br />
![GameMaker](images/tool-gm.png) | __GameMaker__<br />[SDK](https://github.com/YoYoGames/GMEXT-mod.io)<br />[Getting Started](https://github.com/YoYoGames/GMEXT-mod.io/wiki)<br /> | ![C/C++ SDK](images/tool-ccpp.png) | __C/C++ SDK__<br />[SDK](https://github.com/modio/modio-sdk)<br />[Getting Started](https://go.mod.io/sdk-docs)<br />
![Unity Plugin](images/tool-unity.png) | __Unity Plugin__<br />[SDK](https://github.com/modio/modio-unity)<br />[Getting Started](--parse_docsurl/unityref/)<br />[Sample Project](https://github.com/modio/modio-unity-sample)<br /> | ![Unreal Plugin](images/tool-unreal.png) | __Unreal Plugin__<br />[SDK](https://github.com/modio/modio-ue)<br />[Getting Started](--parse_docsurl/unrealref/)<br />[UE4 Sample Project](https://github.com/modio/modio-ue4-sample)<br />[UE5 Sample Project](https://github.com/modio/modio-ue5-sample)<br />
![GameMaker](images/tool-gm.png) | __GameMaker__<br />[SDK](https://github.com/YoYoGames/GMEXT-mod.io)<br />[Getting Started](https://github.com/YoYoGames/GMEXT-mod.io/wiki)<br /> | ![C/C++ SDK](images/tool-ccpp.png) | __C/C++ SDK__<br />[SDK](https://github.com/modio/modio-sdk)<br />[Getting Started](--parse_docsurl/cppsdkref/)<br />
![Discord Bot](images/tool-discordbot.png) | __Discord Bot__<br />[Instructions](https://github.com/modio/modio-discord-bot)<br />[Invite](--parse_discordboturl)<br /> |

### Community Tools
Expand Down
10 changes: 5 additions & 5 deletions source/index.html.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ language_tabs:
- python: Python
- java: Java
toc_footers:
- <a href="https://mod.io/about">Find out more about mod.io</a>
- <a href="https://mod.io">Find out more about mod.io</a>
includes: []
search: true
highlight_theme: darkula
Expand All @@ -27,7 +27,7 @@ __API path:__ [https://*.modapi.io/v1](https://*.modapi.io/v1) (see your API acc

__Current version:__ <select id="version_dropdown" onChange="changeVersion"><option value="" data-latest="true">v1 (latest)</option></select>

<a href="/changelog"><span class="versionwrap">View Version Changelog</span></a>
<a href="changelog/"><span class="versionwrap">View Version Changelog</span></a>

## How It Works

Expand All @@ -42,7 +42,7 @@ Once you have added your game to mod.io and got your [game ID and API key](https
Option | Usage | Suited for | Docs
---------- | ---------- | ---------- | ---------
__API__ | For connecting directly to the mod.io REST API. | Web apps that need a JSON REST API, or game developers that like a challenge and want control over their implementation. | You are reading them
__SDK__ | Drop our [open source C/C++ SDK](https://github.com/modio/modio-sdk) into your game to call mod.io functionality. | Developers that want a SDK that abstracts the uploading, downloading and unzip flows behind easy to use function calls. | [Here](https://go.mod.io/sdk-docs)
__SDK__ | Drop our [open source C/C++ SDK](https://github.com/modio/modio-sdk) into your game to call mod.io functionality. | Developers that want a SDK that abstracts the uploading, downloading and unzip flows behind easy to use function calls. | [Here](https://docs.mod.io/cppsdkref/)
__Tools/Plugins__ | Use tools, plugins and wrappers created by the community to make implementation in various engines easy. | Game developers that want a pre-built modding solution for their engine (Unity, Unreal, GameMaker, Construct) of choice. | Available below

### Official Tools
Expand All @@ -51,8 +51,8 @@ Plugins and wrappers made or supported by the mod.io team

| - | - | -
--- | --- | --- | ---
![Unity Plugin](images/tool-unity.png) | __Unity Plugin__<br />[SDK](https://github.com/modio/modio-unity)<br />[Getting Started](https://go.mod.io/unity-docs)<br />[Sample Project](https://go.mod.io/unity-samples)<br /> | ![Unreal Plugin](images/tool-unreal.png) | __Unreal Plugin__<br />[SDK](https://github.com/modio/modio-ue)<br />[Getting Started](https://go.mod.io/ue-docs)<br />[UE4 Sample Project](https://go.mod.io/ue-samples)<br />[UE5 Sample Project](https://go.mod.io/ue5-sample)<br />
![GameMaker](images/tool-gm.png) | __GameMaker__<br />[SDK](https://github.com/YoYoGames/GMEXT-mod.io)<br />[Getting Started](https://github.com/YoYoGames/GMEXT-mod.io/wiki)<br /> | ![C/C++ SDK](images/tool-ccpp.png) | __C/C++ SDK__<br />[SDK](https://github.com/modio/modio-sdk)<br />[Getting Started](https://go.mod.io/sdk-docs)<br />
![Unity Plugin](images/tool-unity.png) | __Unity Plugin__<br />[SDK](https://github.com/modio/modio-unity)<br />[Getting Started](https://docs.mod.io/unityref/)<br />[Sample Project](https://github.com/modio/modio-unity-sample)<br /> | ![Unreal Plugin](images/tool-unreal.png) | __Unreal Plugin__<br />[SDK](https://github.com/modio/modio-ue)<br />[Getting Started](https://docs.mod.io/unrealref/)<br />[UE4 Sample Project](https://github.com/modio/modio-ue4-sample)<br />[UE5 Sample Project](https://github.com/modio/modio-ue5-sample)<br />
![GameMaker](images/tool-gm.png) | __GameMaker__<br />[SDK](https://github.com/YoYoGames/GMEXT-mod.io)<br />[Getting Started](https://github.com/YoYoGames/GMEXT-mod.io/wiki)<br /> | ![C/C++ SDK](images/tool-ccpp.png) | __C/C++ SDK__<br />[SDK](https://github.com/modio/modio-sdk)<br />[Getting Started](https://docs.mod.io/cppsdkref/)<br />
![Discord Bot](images/tool-discordbot.png) | __Discord Bot__<br />[Instructions](https://github.com/modio/modio-discord-bot)<br />[Invite](https://discordbot.mod.io)<br /> |

### Community Tools
Expand Down
8 changes: 4 additions & 4 deletions source/layouts/layout.erb
Original file line number Diff line number Diff line change
Expand Up @@ -33,12 +33,12 @@ under the License.
<meta name="viewport" content="width=device-width, initial-scale=1, maximum-scale=1">
<title><%= current_page.data.title || "API Documentation" %></title>
<meta name="keywords" content="pc, games, mods, api, documentation, rest, web">
<meta name="description" content="Documentation for working with the mod.io API to download and install mods automatically in games.">
<meta name="description" content="Documentation for working with the mod.io REST API to download and install mods automatically in games.">

<!-- facebook -->
<meta property="fb:app_id" content="1902604976636285">
<meta property="og:title" content="<%= current_page.data.title || "API Documentation" %>">
<meta property="og:description" content="Documentation for working with the mod.io API to download and install mods automatically in games.">
<meta property="og:description" content="Documentation for working with the mod.io REST API to download and install mods automatically in games.">
<meta property="og:site_name" content="mod.io">
<meta property="og:type" content="website">
<meta property="og:image" content="/images/splash.png">
Expand All @@ -47,7 +47,7 @@ under the License.
<meta property="twitter:card" content="summary_large_image">
<meta property="twitter:site" content="@modiohq">
<meta property="twitter:title" content="<%= current_page.data.title || "API Documentation" %>">
<meta property="twitter:description" content="Documentation for working with the mod.io API to download and install mods automatically in games.">
<meta property="twitter:description" content="Documentation for working with the mod.io REST API to download and install mods automatically in games.">
<meta property="twitter:image" content="/images/splash.png">

<!-- icons -->
Expand Down Expand Up @@ -123,7 +123,7 @@ under the License.
</span>
</a>
<div class="toc-wrapper">
<a href="https://mod.io"><%= image_tag "logo.svg", class: 'logo' %></a>
<a href="/"><%= image_tag "logo.svg", class: 'logo' %></a>
<% if language_tabs.any? %>
<div class="lang-selector">
<% language_tabs.each do |lang| %>
Expand Down
18 changes: 9 additions & 9 deletions source/stylesheets/_variables.scss
Original file line number Diff line number Diff line change
Expand Up @@ -23,17 +23,17 @@ under the License.

// BACKGROUND COLORS
////////////////////
$nav-bg: #212945 !default;
$examples-bg: #2d375d !default;
$code-bg: #212945 !default;
$code-annotation-bg: #2d375d !default;
$nav-subitem-bg: #2d375d !default;
$nav-bg: #000000 !default;
$examples-bg: #29292B !default;
$code-bg: #000000 !default;
$code-annotation-bg: #29292B !default;
$nav-subitem-bg: #29292B !default;
$nav-active-bg: #07c1d8 !default;
$nav-active-parent-bg: #2d375d !default; // parent links of the current section
$lang-select-border: #2d375d !default;
$lang-select-bg: #2d375d !default;
$nav-active-parent-bg: #29292B !default; // parent links of the current section
$lang-select-border: #29292B !default;
$lang-select-bg: #29292B !default;
$lang-select-active-bg: #07c1d8 !default; // feel free to change this to blue or something
$lang-select-pressed-bg: #212945 !default; // color of language tab bg when mouse is pressed
$lang-select-pressed-bg: #000000 !default; // color of language tab bg when mouse is pressed
$main-bg: #fff !default;
$aside-notice-bg: #a4e7f2 !default;
$aside-warning-bg: #f2a4a4 !default;
Expand Down

0 comments on commit 68c97ba

Please sign in to comment.