Skip to content

Commit

Permalink
Fixed documentation errors
Browse files Browse the repository at this point in the history
  • Loading branch information
Vorlias committed Jan 21, 2021
1 parent 68c25ac commit be54b87
Show file tree
Hide file tree
Showing 5 changed files with 8 additions and 200 deletions.
4 changes: 2 additions & 2 deletions MIGRATION.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,13 +5,13 @@
### Server
- Events and functions now have _middleware_. Runtime type checking is now done via the `TypeChecker` middleware.
- `Net.ServerEvent` is now `Net.Server.Event`
- `Net.ServerFunction` is now gone, in favour of `Net.Server.AsyncFunction`
- `Net.ServerFunction` is now `Net.Server.Function`
- `Net.ServerAsyncFunction` is now `Net.Server.AsyncFunction`
- `Net.GlobalServerEvent` is now `Net.Server.CrossServerEvent`
- `Net.ServerThrottledEvent` is now gone - use the `RateLimit` middleware.
- `Net.ServerThrottledFunction` is now gone - use the `RateLimit` middleware.
### Client
- `Net.ClientEvent` is now `Net.Client.Event`
- `Net.ClientFunction` is gone, in favour of `Net.Client.AsyncFunction`
- `Net.ClientFunction` is now `Net.Client.Function`
- `Net.ClientAsyncFunction` is now `Net.Client.AsyncFunction`
- `Net.GlobalClientEvent` is now `Net.Client.CrossServerEvent`
2 changes: 1 addition & 1 deletion docs/docs/guides/basic-usage.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
id: basics
title: Basics
sidebar_label: Basics*
sidebar_label: Basics
slug: /basic-usage
---

Expand Down
2 changes: 1 addition & 1 deletion docs/docs/guides/uuid.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ A feature that can be leveraged with the power of the roblox-ts compiler, is a t
If used correctly it should make it quite hard to make exploit tools for your game, and throw off most exploiters.

:::caution
It is not an anti-exploit solution, but a [good piece of cheese](https://utkusen.com/blog/security-by-obscurity-is-underrated.html) in preventing exploits. You _should always_ secure your remotes yourself, using things like the [runtime type checking middleware](/docs/2.x/middleware/types). Doesn't hurt to add another layer of cheese.
It is not an anti-exploit solution, but a [good piece of cheese](https://utkusen.com/blog/security-by-obscurity-is-underrated.html) in preventing exploits. You _should always_ secure your remotes yourself, using things like the [runtime type checking middleware](/docs/2.0/middleware/types). Doesn't hurt to add another layer of cheese.
:::


Expand Down
192 changes: 0 additions & 192 deletions docs/src/pages/alpha.js

This file was deleted.

8 changes: 4 additions & 4 deletions docs/src/pages/index.js
Original file line number Diff line number Diff line change
Expand Up @@ -34,10 +34,10 @@ const features = [
description: (
<>
RbxNet comes with built-in useful middleware such as{" "}
<Link to="/docs/2.x/middleware/types">RuntimeTypeCheck</Link> and{" "}
<Link to="/docs/2.x/middleware/rate-limit">RateLimit</Link>, but you can
<Link to="/docs/2.0/middleware/types">RuntimeTypeCheck</Link> and{" "}
<Link to="/docs/2.0/middleware/rate-limit">RateLimit</Link>, but you can
also roll your{" "}
<Link to="/docs/2.x/middleware/custom">own custom middleware</Link>.
<Link to="/docs/2.0/middleware/custom">own custom middleware</Link>.
</>
),
},
Expand All @@ -47,7 +47,7 @@ const features = [
description: (
<>
Take advantage of the declarative{" "}
<Link to="/docs/2.x/definitions">Definitions API</Link>, which allows
<Link to="/docs/2.0/definitions">Definitions API</Link>, which allows
you to define your remote instances in one place, and use anywhere else.
Types generated for you.
</>
Expand Down

0 comments on commit be54b87

Please sign in to comment.