Search Unity

Manual broken link

Discussion in 'Documentation' started by Telsek, Mar 24, 2015.

  1. Telsek

    Telsek

    Joined:
    Dec 3, 2014
    Posts:
    9
  2. proandrius

    proandrius

    Unity Technologies

    Joined:
    Dec 4, 2012
    Posts:
    542
    Hey, that's cool I will make sure that will get fixed. :)
     
  3. Telsek

    Telsek

    Joined:
    Dec 3, 2014
    Posts:
    9
  4. Rasmus Selsmark

    Rasmus Selsmark

    Joined:
    Mar 13, 2013
    Posts:
    120
    @Telsek, thanks a lot for your effort, and we apologize for the broken links in the 5.0 documentation. We have earlier mentioned in public that our goal was zero broken links in the 5.0 documentation, however we unfortunately didn't make this.

    As part of internal build process, we actually are validating broken links in built docs, as well as Google Analytics also helps us identify external broken links on the published docs. So really no need for you to manually verify broken links, but feel free to look for other kinds of issues in the docs, i.e. content which can be improved etc.

    We're actively working on reducing the number of broken links even further for 5.1 docs, still with the goal of reaching zero broken links.

    The full list of broken links for 5.0 docs:

    #------------------------------------------------------------
    # ERROR 33 missing html files (cross referenced)
    #------------------------------------------------------------
    /../Manual/Lightmapping.html
    used in 5 files:
    /../Manual/HOWTO-ImportObjectMax.html
    /../Manual/Lights.html
    /../Manual/OptimizingGraphicsPerformance.html
    /../Manual/OtherViews.html
    /../Manual/StaticObjects.html

    /../Manual/LightmappingInDepth.html
    used in 2 files:
    /../Manual/SL-SurfaceShaders.html
    /../Manual/class-Light.html

    /../Manual/LightmappingUV.html
    used in 2 files:
    /../Manual/FBXImporter-Model.html
    /../Manual/HOWTO-importObject.html

    /../Manual/MecanimAnimationSystem.html
    used in 1 file:
    /../ScriptReference/Animation.html

    /../Manual/class-LightProbe.html
    used in 1 file:
    /../Manual/StandardShaderContextAndContent.html

    /../Manual/class-PhysicMaterial.html
    used in 7 files:
    /../Manual/CollidersOverview.html
    /../Manual/class-BoxCollider.html
    /../Manual/class-CapsuleCollider.html
    /../Manual/class-MeshCollider.html
    /../Manual/class-SphereCollider.html
    /../Manual/class-TerrainCollider.html
    /../Manual/class-WheelCollider.html

    /../Manual/class-RenderSettings.html
    used in 36 files:
    /../Manual/CamerasOverview.html
    /../Manual/SL-Fog.html
    /../Manual/SL-Material.html
    /../Manual/class-Camera.html
    /../Manual/class-Halo.html
    /../Manual/class-Light.html
    /../ScriptReference/CameraClearFlags.Skybox.html
    /../ScriptReference/FogMode.Exponential.html
    /../ScriptReference/FogMode.ExponentialSquared.html
    /../ScriptReference/FogMode.Linear.html
    /../ScriptReference/FogMode.html
    /../ScriptReference/RenderSettings-ambientEquatorColor.html
    /../ScriptReference/RenderSettings-ambientGroundColor.html
    /../ScriptReference/RenderSettings-ambientLight.html
    /../ScriptReference/RenderSettings-ambientMode.html
    /../ScriptReference/RenderSettings-ambientProbe.html
    /../ScriptReference/RenderSettings-ambientSkyColor.html
    /../ScriptReference/RenderSettings-customReflection.html
    /../ScriptReference/RenderSettings-defaultReflectionMode.html
    /../ScriptReference/RenderSettings-flareFadeSpeed.html
    /../ScriptReference/RenderSettings-flareStrength.html
    /../ScriptReference/RenderSettings-fog.html
    /../ScriptReference/RenderSettings-fogColor.html
    /../ScriptReference/RenderSettings-fogDensity.html
    /../ScriptReference/RenderSettings-fogEndDistance.html
    /../ScriptReference/RenderSettings-fogMode.html
    /../ScriptReference/RenderSettings-fogStartDistance.html
    /../ScriptReference/RenderSettings-haloStrength.html
    /../ScriptReference/RenderSettings.html
    /../ScriptReference/Rendering.AmbientMode.Flat.html
    /../ScriptReference/Rendering.AmbientMode.Skybox.html
    /../ScriptReference/Rendering.AmbientMode.Trilight.html
    /../ScriptReference/Rendering.AmbientMode.html
    /../ScriptReference/Rendering.DefaultReflectionMode.Custom.html
    /../ScriptReference/Rendering.DefaultReflectionMode.Skybox.html
    /../ScriptReference/Rendering.DefaultReflectionMode.html

    /../ScriptReference/AudioType.GCADPCM.html
    used in 1 file:
    /../ScriptReference/40_history.html

    /../ScriptReference/EventSystems.EventSystem.Update.html
    used in 1 file:
    /../ScriptReference/EventSystems.EventSystem.html

    /../ScriptReference/EventSystems.IInitializePotentialDragHandler.OnInitializePotentialDrag.html
    used in 1 file:
    /../ScriptReference/EventSystems.PointerEventData-useDragThreshold.html

    /../ScriptReference/EventSystems.IInitializePotentialDragHandler.html
    used in 5 files:
    /../ScriptReference/EventSystems.EventTrigger.html
    /../ScriptReference/EventSystems.ExecuteEvents-initializePotentialDrag.html
    /../ScriptReference/UI.ScrollRect.html
    /../ScriptReference/UI.Scrollbar.html
    /../ScriptReference/UI.Slider.html

    /../ScriptReference/RectTransformUtility.PointInRectangleGlobalSpace.html
    used in 1 file:
    /../ScriptReference/EventSystems.IDragHandler.html

    /../ScriptReference/ReflectionProbe-type.html
    used in 3 files:
    /../ScriptReference/Rendering.ReflectionProbeType.Card.html
    /../ScriptReference/Rendering.ReflectionProbeType.Cube.html
    /../ScriptReference/Rendering.ReflectionProbeType.html

    /../ScriptReference/ReflectionProbe.ReflectionProbeRefreshMode.html
    used in 1 file:
    /../ScriptReference/ReflectionProbe-refreshMode.html

    /../ScriptReference/ReflectionProbe.ReflectionProbeTimeSlicingMode.html
    used in 1 file:
    /../ScriptReference/ReflectionProbe-timeSlicingMode.html

    /../ScriptReference/Rendering.ReflectionProbeRefreshMode-timeSlicingMode.html
    used in 1 file:
    /../ScriptReference/Rendering.ReflectionProbeRefreshMode.EveryFrame.html

    /../ScriptReference/Rendering.ReflectionProbeRefreshMode.ReflectionProbe.html
    used in 2 files:
    /../ScriptReference/Rendering.ReflectionProbeRefreshMode.OnAwake.html
    /../ScriptReference/Rendering.ReflectionProbeRefreshMode.ViaScripting.html

    /../ScriptReference/Rendering.ReflectionProbeRefreshMode.RenderProbe.html
    used in 1 file:
    /../ScriptReference/Rendering.ReflectionProbeRefreshMode.OnAwake.html

    /../ScriptReference/Rendering.ReflectionProbeTimeSlicingMode-refreshMode.html
    used in 1 file:
    /../ScriptReference/Rendering.ReflectionProbeTimeSlicingMode.html

    /../ScriptReference/Rendering.ReflectionProbeTimeSlicingMode.ReflectionProbeRefreshMode.html
    used in 1 file:
    /../ScriptReference/Rendering.ReflectionProbeTimeSlicingMode.html

    /../ScriptReference/Texture2D-height.html
    used in 1 file:
    /../ScriptReference/Texture2D.LoadRawTextureData.html

    /../ScriptReference/Texture2D-width.html
    used in 1 file:
    /../ScriptReference/Texture2D.LoadRawTextureData.html

    /../ScriptReference/UI.Image-color.html
    used in 1 file:
    /../ScriptReference/UI.Image-eventAlphaThreshold.html

    /../ScriptReference/UI.InputField-caretPosition.html
    used in 1 file:
    /../ScriptReference/UI.InputField.SelectAll.html

    /../ScriptReference/UI.InputField-caretSelectPos.html
    used in 1 file:
    /../ScriptReference/UI.InputField.SelectAll.html

    /../ScriptReference/UI.InputField.OnChangeEvent.html
    used in 1 file:
    /../ScriptReference/UI.InputField-onValueChange.html

    /../ScriptReference/UI.ScrollRect-inertia.html
    used in 1 file:
    /../ScriptReference/UI.ScrollRect-decelerationRate.html

    /Lightmapping.html
    used in 5 files:
    /HOWTO-ImportObjectMax.html
    /Lights.html
    /OptimizingGraphicsPerformance.html
    /OtherViews.html
    /StaticObjects.html

    /LightmappingInDepth.html
    used in 2 files:
    /SL-SurfaceShaders.html
    /class-Light.html

    /LightmappingUV.html
    used in 2 files:
    /FBXImporter-Model.html
    /HOWTO-importObject.html

    /class-LightProbe.html
    used in 1 file:
    /StandardShaderContextAndContent.html

    /class-PhysicMaterial.html
    used in 7 files:
    /CollidersOverview.html
    /class-BoxCollider.html
    /class-CapsuleCollider.html
    /class-MeshCollider.html
    /class-SphereCollider.html
    /class-TerrainCollider.html
    /class-WheelCollider.html

    /class-RenderSettings.html
    used in 6 files:
    /CamerasOverview.html
    /SL-Fog.html
    /SL-Material.html
    /class-Camera.html
    /class-Halo.html
    /class-Light.html

    #------------------------------------------------------------
    # ERROR 11 missing other files (cross referenced)
    #------------------------------------------------------------
    /../Manual/AnimatorCurves
    used in 3 files:
    /../Manual/AnimationParameters.html
    /../Manual/ScriptingRootMotion.html
    /../Manual/class-AnimationClip.html

    /../Manual/UIVisualElements
    used in 1 file:
    /../Manual/UIInteractionComponents.html

    /../Manual/class-ContentSizeFitter
    used in 1 file:
    /../Manual/script-GridLayoutGroup.html

    /../Manual/script-EventTrigger
    used in 1 file:
    /../Manual/script-Button.html

    /../Manual/shader-StandardShaderFundamentals
    used in 1 file:
    /../Manual/terrain-OtherSettings.html

    /../uploads/Main/WSANativePluginsV1.zip
    used in 2 files:
    /../Manual/windowsstore-examples.html
    /windowsstore-examples.html

    /AnimatorCurves
    used in 3 files:
    /AnimationParameters.html
    /ScriptingRootMotion.html
    /class-AnimationClip.html

    /UIVisualElements
    used in 1 file:
    /UIInteractionComponents.html

    /class-ContentSizeFitter
    used in 1 file:
    /script-GridLayoutGroup.html

    /script-EventTrigger
    used in 1 file:
    /script-Button.html

    /shader-StandardShaderFundamentals
    used in 1 file:
    /terrain-OtherSettings.html
     
  5. Telsek

    Telsek

    Joined:
    Dec 3, 2014
    Posts:
    9
    oh that's cool. :)
    As I mentioned, I'm reading the entire manual from start to finish
    not in purpose for links verification :D but for professional enrichment.
    It's only fair to help back by reporting damaged links.

    thanks and regards
     
    proandrius likes this.
  6. andeeeee

    andeeeee

    Joined:
    Jul 19, 2005
    Posts:
    8,768
    Just to update you, I've fixed the broken links in the manual (in source, at least) and I understand my colleague is fixing the ones in the script ref. All the fixes should be available online soon.
     
  7. Ramcat

    Ramcat

    Joined:
    Aug 16, 2014
    Posts:
    92
  8. Graham-Dunnett

    Graham-Dunnett

    Unity Technologies

    Joined:
    Jun 2, 2009
    Posts:
    4,288
    The docs were updated today, and I can't see the missing link any more.
     
  9. Ramcat

    Ramcat

    Joined:
    Aug 16, 2014
    Posts:
    92
  10. Ramcat

    Ramcat

    Joined:
    Aug 16, 2014
    Posts:
    92
  11. Graham-Dunnett

    Graham-Dunnett

    Unity Technologies

    Joined:
    Jun 2, 2009
    Posts:
    4,288
    Fixed those, will be published live on the next push.