Merge pull request #376 from jdcook/feature/doc-updates

docs: fixed some typos, added some links, added prefab hash info

Author: TwoTenPvP

MLAPI/Messaging/CustomMessageManager.cs

@@ -157,7 +157,7 @@ public static void UnregisterNamedMessageHandler(string name)
         /// <param name="name">The message name to send</param>
         /// <param name="clientId">The client to send the message to</param>
         /// <param name="stream">The message stream containing the data</param>
-        /// <param name="channel">The channel tos end the data on</param>
+        /// <param name="channel">The channel to send the data on</param>
         /// <param name="security">The security settings to apply to the message</param>
         public static void SendNamedMessage(string name, ulong clientId, Stream stream, string channel = null, SecuritySendFlags security = SecuritySendFlags.None)
         {

docs/_docs/advanced-topics/bitwriter-bitreader-bitstream.md

@@ -3,10 +3,10 @@ title: BitWriter, BitReader & BitStream
 permalink: /wiki/bitwriter-bitreader-bitstream/
 ---
 
-Internally, the MLAPI uses Streams for it's data. This gives a ton of flexibility for the end user. If the end user for example doesn't want to use Streams but rather just byte arrays at their own level. They can do so by wrapping their arrays in MemoryStreams which doesn't create any garbage.
+Internally, the MLAPI uses Streams for it's data. This gives a ton of flexibility for the end user. If the end user for example doesn't want to use Streams but rather just byte arrays at their own level. They can do so by wrapping their arrays in MemoryStreams which don't create any garbage.
 
 
-The MLAPI does have it's own prefered Stream that is used internally. It's called the BitStream.
+The MLAPI does have its own prefered Stream that is used internally. It's called the BitStream.
 
 ## BitStream
 The BitStream is a Stream implementation that functions in a similar way as the MemoryStream. The main difference is that the BitStream have methods for operating on the Bit level rather than the Byte level.
@@ -34,18 +34,18 @@ When using the "Packed" versions of a write or read, the output will be VarInted
 When using the "Diff" versions of an array write or read, the output will be the diff between two arrays, allowing for delta encoding.
 
 #### Unity Types
-The BitWriter & BitReader supports many data types by default such as Vector3, Vector2, Ray, Quaternion and more.
+The BitWriter & BitReader support many data types by default such as Vector3, Vector2, Ray, Quaternion and more.
 
 #### BitWise Writing
-If you for example have an enum with 5 values. All those values could be fit into 3 bits. With the BitWriter, this can be done like this:
+If you for example have an enum with 5 values. All those values could fit into 3 bits. With the BitWriter, this can be done like this:
 
 ```csharp
 writer.WriteBits((byte)MyEnum.MyEnumValue, 3);
 MyEnum value = (Myenum)reader.ReadBits(3);
 ```
 
-#### Performance concideration
-When the stream is not aligned, (BitAligned == false, this occurs when writing bits that does fill the whole byte, or when writing bools as they are written as bits), performance is decreased for each write and read. This is only a big concern if you are about to write a large amount of data after not being aligned. To solve this, the BitWriter allows you to "WritePadBits" and the BitReader then lets you skip those bits with "SkipPadBits" to align the stream to the nearest byte.
+#### Performance consideration
+When the stream is not aligned, (BitAligned == false, this occurs when writing bits that do fill the whole byte, or when writing bools as they are written as bits), performance is decreased for each write and read. This is only a big concern if you are about to write a large amount of data after not being aligned. To solve this, the BitWriter allows you to "WritePadBits" and the BitReader then lets you skip those bits with "SkipPadBits" to align the stream to the nearest byte.
 
 ```csharp
 writer.WriteBool(true); //Now the stream is no longer aligned. Every byte has to be offset by 1 bit.
@@ -59,7 +59,7 @@ reader.ReadByteArray(myOutputArray, 1024);
 ```
 
 ### Pooled BitReader/Writer
-The writer and reader also has pooled versions to avoid allocating the classes themselves. You might aswell use them.
+The writer and reader also has pooled versions to avoid allocating the classes themselves. You might as well use them.
 
 ```csharp
 using (PooledBitReader reader = PooledBitReader.Get(myStreamToReadFrom))

docs/_docs/core-components/networked-object.md

@@ -7,4 +7,4 @@ The NetworkedObject is a fairly simple component. It has no settings. It's a com
 
 If you want to use NetworkedBehaviours. You need a NetworkedObject at the same GameObject or in a parent. Each NetworkedObject has a "netId", a networkId for the GameObject. This is used by many parts of the MLAPI. From the message targeting system to the object spawning.
 
-The components presence should have no performance impact as it has to game loop.
+The component's presence should have no performance impact as it has no game loop.

docs/_docs/getting-started/connection-approval.md

@@ -19,7 +19,9 @@ private void ApprovalCheck(byte[] connectionData, ulong clientId, MLAPI.Networki
     bool approve = true;
     bool createPlayerObject = true;
 
-    ulong? prefabHash = SpawnManager.GetPrefabHashFromGenerator("MyPrefabHashGenerator"); // The prefab hash. Use null to use the default player prefab
+    // The prefab hash. Use null to use the default player prefab
+    // If using this hash, replace "MyPrefabHashGenerator" with the name of a prefab added to the NetworkedPrefabs field of your NetworkingManager object in the scene
+    ulong? prefabHash = SpawnManager.GetPrefabHashFromGenerator("MyPrefabHashGenerator");
 
     //If approve is true, the connection gets added. If it's false. The client gets disconnected
     callback(createPlayerObject, prefabHash, approve, positionToSpawnAt, rotationToSpawnWith);

docs/_docs/getting-started/installation.md

@@ -10,13 +10,13 @@ To get started with the MLAPI. You need to install the library. The easiest way
 ![Video showing the install process](https://i.imgur.com/zN63DlJ.gif)
 
 
-Once imported into the Unity Engine, you will be able to use the components that it offers. To get started, you need a GameObject with the NetworkingManager component. Once you have that, use the Initializing the library articles to continue.
+Once imported into the Unity Engine, you will be able to use the components that it offers. To get started, you need a GameObject with the NetworkingManager component. Once you have that, use the [Library Initialization](/wiki/library-initialization/) article to continue.
 
 
 ### Files
 The MLAPI comes with 3 main components
 ##### MLAPI.dll
-This DLL's is the runtime portion. The actual library. This file is thus **required**. It comes in two variants. A "Lite" and a normal version. Most people will do fine with the full version. The Lite version has less features. At the time of writing the only difference is that it does not include encryption which adds better support on certain platforms. Note that the lite version might not be as stable as the full version and could contain additional bugs.
+This DLL is the runtime portion. The actual library. This file is thus **required**. It comes in two variants. A "Lite" and a normal version. Most people will do fine with the full version. The Lite version has less features. At the time of writing the only difference is that it does not include encryption which adds better support on certain platforms. Note that the lite version might not be as stable as the full version and could contain additional bugs.
 ##### MLAPI-Editor.unitypackage
 This unitypackage includes the source files for all the Editor scripts. The UnityPackage will automatically place these source files in the Editor folder to avoid it being included in a build. **This is required**.
 ##### MLAPI-Installer.unitypackage

docs/_docs/getting-started/library-initialization.md

@@ -3,7 +3,7 @@ title: Library Initialization
 permalink: /wiki/library-initialization/
 ---
 
-Initializing the MLAPI is fairly simple. You need a GameObject with the NetworkingManager component added to it. The NetworkingManager class has a static singleton reference to itself making it easy to access from anywhere. The first configuration you have to do is to set the Transport. You can read more about Transports on the "Custom Transports" page. 
+Initializing the MLAPI is fairly simple. You need a GameObject with the NetworkingManager component added to it. The NetworkingManager class has a static singleton reference to itself making it easy to access from anywhere. The first configuration you have to do is to set the Transport. You can read more about Transports on the [Custom Transports](/wiki/custom-transports/) page. 
 
 
 To initialize the library. You have three options.