fix: updating HelpUrl for new docs (#1094)

* updated readme to fix missing images and spelling * fix missing images in quick start guide * fix code urls * removed duplicate image
MirageNet · Jul 27, 2022 · e31a5db · e31a5db
1 parent c0dc98e
commit e31a5db
Show file tree

Hide file tree

Showing 23 changed files with 52 additions and 52 deletions.
diff --git a/Assets/Mirage/Components/Experimental/NetworkLerpRigidbody.cs b/Assets/Mirage/Components/Experimental/NetworkLerpRigidbody.cs
@@ -3,7 +3,7 @@
 namespace Mirage.Experimental
 {
     [AddComponentMenu("Network/Experimental/NetworkLerpRigidbody")]
-    [HelpURL("https://miragenet.github.io/Mirage/Articles/Components/NetworkLerpRigidbody.html")]
+    [HelpURL("https://miragenet.github.io/Mirage/docs/components/network-lerp-rigidbody")]
     public class NetworkLerpRigidbody : NetworkBehaviour
     {
         [Header("Settings")]

diff --git a/Assets/Mirage/Components/Experimental/NetworkRigidbody.cs b/Assets/Mirage/Components/Experimental/NetworkRigidbody.cs
@@ -4,7 +4,7 @@
 namespace Mirage.Experimental
 {
     [AddComponentMenu("Network/Experimental/NetworkRigidbody")]
-    [HelpURL("https://miragenet.github.io/Mirage/Articles/Components/NetworkRigidbody.html")]
+    [HelpURL("https://miragenet.github.io/Mirage/docs/components/network-rigidbody")]
     public class NetworkRigidbody : NetworkBehaviour
     {
         private static readonly ILogger logger = LogFactory.GetLogger(typeof(NetworkRigidbody));

diff --git a/Assets/Mirage/Components/Experimental/NetworkTransform.cs b/Assets/Mirage/Components/Experimental/NetworkTransform.cs
@@ -4,7 +4,7 @@ namespace Mirage.Experimental
 {
     [DisallowMultipleComponent]
     [AddComponentMenu("Network/Experimental/NetworkTransformExperimental")]
-    [HelpURL("https://miragenet.github.io/Mirage/Articles/Components/NetworkTransform.html")]
+    [HelpURL("https://miragenet.github.io/Mirage/docs/components/network-transform")]
     public class NetworkTransform : NetworkTransformBase
     {
         protected override Transform TargetTransform => transform;

diff --git a/Assets/Mirage/Components/Experimental/NetworkTransformChild.cs b/Assets/Mirage/Components/Experimental/NetworkTransformChild.cs
@@ -7,7 +7,7 @@ namespace Mirage.Experimental
     /// <para>There must be a NetworkTransform on the root object of the hierarchy. There can be multiple NetworkTransformChild components on an object. This does not use physics for synchronization, it simply synchronizes the localPosition and localRotation of the child transform and lerps towards the received values.</para>
     /// </summary>
     [AddComponentMenu("Network/Experimental/NetworkTransformChildExperimentalExperimental")]
-    [HelpURL("https://miragenet.github.io/Mirage/Articles/Components/NetworkTransformChild.html")]
+    [HelpURL("https://miragenet.github.io/Mirage/docs/components/network-transform-child")]
     public class NetworkTransformChild : NetworkTransformBase
     {
         [Header("Target")]

diff --git a/Assets/Mirage/Components/NetworkAnimator.cs b/Assets/Mirage/Components/NetworkAnimator.cs
@@ -18,7 +18,7 @@ namespace Mirage
     /// </remarks>
     [AddComponentMenu("Network/NetworkAnimator")]
     [RequireComponent(typeof(NetworkIdentity))]
-    [HelpURL("https://miragenet.github.io/Mirage/Articles/Components/NetworkAnimator.html")]
+    [HelpURL("https://miragenet.github.io/Mirage/docs/components/network-animator")]
     public class NetworkAnimator : NetworkBehaviour
     {
         private static readonly ILogger logger = LogFactory.GetLogger(typeof(NetworkAnimator));

diff --git a/Assets/Mirage/Components/NetworkMatchChecker.cs b/Assets/Mirage/Components/NetworkMatchChecker.cs
@@ -12,7 +12,7 @@ namespace Mirage
     [DisallowMultipleComponent]
     [AddComponentMenu("Network/NetworkMatchChecker")]
     [RequireComponent(typeof(NetworkIdentity))]
-    [HelpURL("https://miragenet.github.io/Mirage/Articles/Components/NetworkMatchChecker.html")]
+    [HelpURL("https://miragenet.github.io/Mirage/docs/components/network-match-checker")]
     public class NetworkMatchChecker : NetworkVisibility
     {
         private static readonly Dictionary<Guid, HashSet<NetworkIdentity>> matchPlayers = new Dictionary<Guid, HashSet<NetworkIdentity>>();

diff --git a/Assets/Mirage/Components/NetworkPingDisplay.cs b/Assets/Mirage/Components/NetworkPingDisplay.cs
@@ -8,7 +8,7 @@ namespace Mirage
     /// </summary>
     [DisallowMultipleComponent]
     [AddComponentMenu("Network/NetworkPingDisplay")]
-    [HelpURL("https://miragenet.github.io/Mirage/Articles/Components/NetworkPingDisplay.html")]
+    [HelpURL("https://miragenet.github.io/Mirage/docs/components/network-ping-display")]
     public class NetworkPingDisplay : MonoBehaviour
     {
         public NetworkClient Client;

diff --git a/Assets/Mirage/Components/NetworkProximityChecker.cs b/Assets/Mirage/Components/NetworkProximityChecker.cs
@@ -10,7 +10,7 @@ namespace Mirage
     /// </summary>
     [AddComponentMenu("Network/NetworkProximityChecker")]
     [RequireComponent(typeof(NetworkIdentity))]
-    [HelpURL("https://miragenet.github.io/Mirage/Articles/Components/NetworkProximityChecker.html")]
+    [HelpURL("https://miragenet.github.io/Mirage/docs/components/network-proximity-checker")]
     public class NetworkProximityChecker : NetworkVisibility
     {
         private static readonly ILogger logger = LogFactory.GetLogger(typeof(NetworkProximityChecker));

diff --git a/Assets/Mirage/Components/NetworkTransform.cs b/Assets/Mirage/Components/NetworkTransform.cs
@@ -4,7 +4,7 @@ namespace Mirage
 {
     [DisallowMultipleComponent]
     [AddComponentMenu("Network/NetworkTransform")]
-    [HelpURL("https://miragenet.github.io/Mirage/Articles/Components/NetworkTransform.html")]
+    [HelpURL("https://miragenet.github.io/Mirage/docs/components/network-transform")]
     public class NetworkTransform : NetworkTransformBase
     {
         protected override Transform TargetComponent => transform;

diff --git a/Assets/Mirage/Components/NetworkTransformChild.cs b/Assets/Mirage/Components/NetworkTransformChild.cs
@@ -7,7 +7,7 @@ namespace Mirage
     /// <para>There must be a NetworkTransform on the root object of the hierarchy. There can be multiple NetworkTransformChild components on an object. This does not use physics for synchronization, it simply synchronizes the localPosition and localRotation of the child transform and lerps towards the received values.</para>
     /// </summary>
     [AddComponentMenu("Network/NetworkTransformChild")]
-    [HelpURL("https://miragenet.github.io/Mirage/Articles/Components/NetworkTransformChild.html")]
+    [HelpURL("https://miragenet.github.io/Mirage/docs/components/network-transform-child")]
     public class NetworkTransformChild : NetworkTransformBase
     {
         [Header("Target")]

diff --git a/Assets/Mirage/Components/Visibility/SceneChecking/NetworkSceneChecker.cs b/Assets/Mirage/Components/Visibility/SceneChecking/NetworkSceneChecker.cs
@@ -13,7 +13,7 @@ namespace Mirage
     [DisallowMultipleComponent]
     [AddComponentMenu("Network/NetworkSceneChecker")]
     [RequireComponent(typeof(NetworkIdentity))]
-    [HelpURL("https://miragenet.github.io/Mirage/Articles/Components/NetworkSceneChecker.html")]
+    [HelpURL("https://miragenet.github.io/Mirage/docs/components/network-scene-checker")]
     [System.Obsolete("This checker is inefficient, use SimpleSceneChecker instead")]
     public class NetworkSceneChecker : NetworkVisibility
     {

diff --git a/Assets/Mirage/Editor/WelcomeWindow/WelcomeWindow.cs b/Assets/Mirage/Editor/WelcomeWindow/WelcomeWindow.cs
@@ -32,11 +32,11 @@ public class WelcomeWindow : EditorWindow
 
         #region Urls
 
-        private const string WelcomePageUrl = "https://miragenet.github.io/Mirage/index.html";
-        private const string QuickStartUrl = "https://miragenet.github.io/Mirage/Articles/Guides/CommunityGuides/MirageQuickStartGuide/index.html";
+        private const string WelcomePageUrl = "https://miragenet.github.io/Mirage/";
+        private const string QuickStartUrl = "https://miragenet.github.io/Mirage/docs/guides/community-guides/mirage-quick-start-guide";
         private const string ChangelogUrl = "https://github.com/MirageNet/Mirage/blob/master/Assets/Mirage/CHANGELOG.md";
-        private const string BestPracticesUrl = "https://miragenet.github.io/Mirage/Articles/Guides/BestPractices.html";
-        private const string FaqUrl = "https://miragenet.github.io/Mirage/Articles/Guides/FAQ.html";
+        private const string BestPracticesUrl = "https://miragenet.github.io/Mirage/docs/guides/best-practices";
+        private const string FaqUrl = "https://miragenet.github.io/Mirage/docs/guides/faq";
         private const string DiscordInviteUrl = "https://discord.gg/DTBPBYvexy";
 
 #if UNITY_2021_2_OR_NEWER

diff --git a/Assets/Mirage/Runtime/Logging/LogSettings.cs b/Assets/Mirage/Runtime/Logging/LogSettings.cs
@@ -9,7 +9,7 @@ namespace Mirage.Logging
     /// </summary>
     [DisallowMultipleComponent]
     [AddComponentMenu("Network/LogSettings")]
-    [HelpURL("https://miragenet.github.io/Mirage/Articles/Components/NetworkLogSettings.html")]
+    [HelpURL("https://miragenet.github.io/Mirage/docs/components/network-log-settings")]
     public class LogSettings : MonoBehaviour
     {
         [Header("Log Settings Asset")]

diff --git a/Assets/Mirage/Runtime/NetworkAuthenticator.cs b/Assets/Mirage/Runtime/NetworkAuthenticator.cs
@@ -6,7 +6,7 @@ namespace Mirage
     /// <summary>
     /// Base class for implementing component-based authentication during the Connect phase
     /// </summary>
-    [HelpURL("https://miragenet.github.io/Mirage/Articles/Components/Authenticators/index.html")]
+    [HelpURL("https://miragenet.github.io/Mirage/docs/components/authenticators/")]
     public abstract class NetworkAuthenticator : MonoBehaviour
     {
         /// <summary>

diff --git a/Assets/Mirage/Runtime/NetworkBehaviour.cs b/Assets/Mirage/Runtime/NetworkBehaviour.cs
@@ -23,7 +23,7 @@ public enum SyncMode { Observers, Owner }
     /// <para>Some of the built-in components of the networking system are derived from NetworkBehaviour, including NetworkTransport, NetworkAnimator and NetworkProximityChecker.</para>
     /// </remarks>
     [AddComponentMenu("")]
-    [HelpURL("https://miragenet.github.io/Mirage/Articles/Guides/GameObjects/NetworkBehaviour.html")]
+    [HelpURL("https://miragenet.github.io/Mirage/docs/guides/game-objects/network-behaviour")]
     public abstract class NetworkBehaviour : MonoBehaviour
     {
         private static readonly ILogger logger = LogFactory.GetLogger(typeof(NetworkBehaviour));

diff --git a/Assets/Mirage/Runtime/NetworkIdentity.cs b/Assets/Mirage/Runtime/NetworkIdentity.cs
@@ -30,12 +30,12 @@ namespace Mirage
     ///     The NetworkIdentity manages the dirty state of the NetworkBehaviours of the object.
     ///     When it discovers that NetworkBehaviours are dirty, it causes an update packet to be created and sent to clients.
     /// </para>
-    /// 
+    ///
     /// <list type="bullet">
     ///     <listheader><description>
     ///         The flow for serialization updates managed by the NetworkIdentity is:
     ///     </description></listheader>
-    ///     
+    ///
     ///     <item><description>
     ///         Each NetworkBehaviour has a dirty mask. This mask is available inside OnSerialize as syncVarDirtyBits
     ///     </description></item>
@@ -71,12 +71,12 @@ namespace Mirage
     ///         The UpdateVars packet is sent to ready clients that are observing the object
     ///     </description></item>
     /// </list>
-    /// 
+    ///
     /// <list type="bullet">
     ///     <listheader><description>
     ///         On the client:
     ///     </description></listheader>
-    /// 
+    ///
     ///     <item><description>
     ///         an UpdateVars packet is received for an object
     ///     </description></item>
@@ -99,7 +99,7 @@ namespace Mirage
     /// </remarks>
     [DisallowMultipleComponent]
     [AddComponentMenu("Network/NetworkIdentity")]
-    [HelpURL("https://miragenet.github.io/Mirage/Articles/Components/NetworkIdentity.html")]
+    [HelpURL("https://miragenet.github.io/Mirage/docs/components/network-identity")]
     public sealed class NetworkIdentity : MonoBehaviour
     {
         private static readonly ILogger logger = LogFactory.GetLogger<NetworkIdentity>();

diff --git a/Assets/Mirage/Runtime/NetworkManager.cs b/Assets/Mirage/Runtime/NetworkManager.cs
@@ -14,7 +14,7 @@ public enum NetworkManagerMode
     }
 
     [AddComponentMenu("Network/NetworkManager")]
-    [HelpURL("https://miragenet.github.io/Mirage/Articles/Guides/Callbacks/NetworkManager.html")]
+    [HelpURL("https://miragenet.github.io/Mirage/docs/guides/callbacks/network-manager")]
     [DisallowMultipleComponent]
     public class NetworkManager : MonoBehaviour
     {

diff --git a/Assets/Mirage/Runtime/Serialization/GenericTypesSerializationExtensions.cs b/Assets/Mirage/Runtime/Serialization/GenericTypesSerializationExtensions.cs
@@ -48,7 +48,7 @@ public static void Write<T>(this NetworkWriter writer, T value)
 
         private static void ThrowIfWriterNotFound<T>()
         {
-            throw new KeyNotFoundException($"No writer found for {typeof(T)}. See https://miragenet.github.io/Mirage/Articles/General/Troubleshooting.html for details");
+            throw new KeyNotFoundException($"No writer found for {typeof(T)}. See https://miragenet.github.io/Mirage/docs/general/troubleshooting for details");
         }
 
         /// <summary>
@@ -69,7 +69,7 @@ public static T Read<T>(this NetworkReader reader)
 
         private static void ThrowIfReaderNotFound<T>()
         {
-            throw new KeyNotFoundException($"No reader found for {typeof(T)}. See https://miragenet.github.io/Mirage/Articles/General/Troubleshooting.html for details");
+            throw new KeyNotFoundException($"No reader found for {typeof(T)}. See https://miragenet.github.io/Mirage/docs/general/troubleshooting for details");
         }
     }
 }
diff --git a/Assets/Mirage/Runtime/Serialization/WeaverAttributes.cs b/Assets/Mirage/Runtime/Serialization/WeaverAttributes.cs
@@ -39,7 +39,7 @@ public sealed class WeaverIgnoreAttribute : Attribute { }
     /// <para>
     /// NOTE: bits are truncated when using this, so signed values will lose their sign. Use <see cref="ZigZagEncodeAttribute"/> as well if value might be negative
     /// </para>
-    /// <para>Also See: <see href="https://miragenet.github.io/Mirage/Articles/Guides/BitPacking/BitCount.html">Bit Packing Documentation</see></para>
+    /// <para>Also See: <see href="https://miragenet.github.io/Mirage/docs/guides/bit-packing/bit-countl">Bit Packing Documentation</see></para>
     /// </summary>
     [AttributeUsage(AttributeTargets.Field | AttributeTargets.Parameter)]
     public class BitCountAttribute : Attribute
@@ -50,7 +50,7 @@ public class BitCountAttribute : Attribute
 
     /// <summary>
     /// Calculates bitcount from then given min/max values and then packs using <see cref="BitCountAttribute"/>
-    /// <para>Also See: <see href="https://miragenet.github.io/Mirage/Articles/Guides/BitPacking/BitCountFromRange.html">Bit Packing Documentation</see></para>
+    /// <para>Also See: <see href="https://miragenet.github.io/Mirage/docs/guides/bit-packing/bit-count-from-range">Bit Packing Documentation</see></para>
     /// </summary>
     [AttributeUsage(AttributeTargets.Field | AttributeTargets.Parameter)]
     public class BitCountFromRangeAttribute : Attribute
@@ -62,7 +62,7 @@ public class BitCountFromRangeAttribute : Attribute
 
     /// <summary>
     /// Used along size <see cref="BitCountAttribute"/> to encodes a interager value using <see cref="ZigZag"/> so that both positive and negative values can be sent
-    /// <para>Also See: <see href="https://miragenet.github.io/Mirage/Articles/Guides/BitPacking/BitCountFromRange.html">Bit Packing Documentation</see></para>
+    /// <para>Also See: <see href="https://miragenet.github.io/Mirage/docs/guides/bit-packing/bit-count-from-rangel">Bit Packing Documentation</see></para>
     /// </summary>
     [AttributeUsage(AttributeTargets.Field | AttributeTargets.Parameter)]
     public class ZigZagEncodeAttribute : Attribute
@@ -71,8 +71,8 @@ public class ZigZagEncodeAttribute : Attribute
     }
 
     /// <summary>
-    /// Packs a float field, clamped from -max to +max, with 
-    /// <para>Also See: <see href="https://miragenet.github.io/Mirage/Articles/Guides/BitPacking/BitCountFromRange.html">Bit Packing Documentation</see></para>
+    /// Packs a float field, clamped from -max to +max, with
+    /// <para>Also See: <see href="https://miragenet.github.io/Mirage/docs/guides/bit-packing/bit-count-from-range">Bit Packing Documentation</see></para>
     /// </summary>
     [AttributeUsage(AttributeTargets.Field | AttributeTargets.Parameter)]
     public class FloatPackAttribute : Attribute
@@ -87,7 +87,7 @@ public class FloatPackAttribute : Attribute
     }
 
     /// <summary>
-    /// 
+    ///
     /// </summary>
     public class Vector3PackAttribute : Attribute
     {
@@ -99,7 +99,7 @@ public class Vector3PackAttribute : Attribute
     }
 
     /// <summary>
-    /// 
+    ///
     /// </summary>
     public class Vector2PackAttribute : Attribute
     {
@@ -111,7 +111,7 @@ public class Vector2PackAttribute : Attribute
     }
 
     /// <summary>
-    /// 
+    ///
     /// </summary>
     public class QuaternionPackAttribute : Attribute
     {
@@ -147,7 +147,7 @@ public class VarIntBlocksAttribute : Attribute
         /// </summary>
 
         /// <summary>
-        /// 
+        ///
         /// </summary>
         /// <param name="blockSize">Value should be between 1 and 64</param>
         public VarIntBlocksAttribute(int blockSize) { }