Skip to content

Fix broken and updated links in the Rebel Engine API documentation#89

Merged
DanielaOrtner merged 1 commit into
RebelToolbox:mainfrom
madmiraal:fix-api-links
Jul 22, 2024
Merged

Fix broken and updated links in the Rebel Engine API documentation#89
DanielaOrtner merged 1 commit into
RebelToolbox:mainfrom
madmiraal:fix-api-links

Conversation

@madmiraal
Copy link
Copy Markdown
Contributor

Fix broken internal Rebel Documentation links in:

  • docs/Engine.xml
  • docs/Node.xml
  • modules/csg/docs/CSGBox.xml
  • modules/csg/docs/CSGCombiner.xml
  • modules/csg/docs/CSGCylinder.xml
  • modules/csg/docs/CSGMesh.xml
  • modules/csg/docs/CSGPolygon.xml
  • modules/csg/docs/CSGPrimitive.xml
  • modules/csg/docs/CSGShape.xml
  • modules/csg/docs/CSGSphere.xml
  • modules/csg/docs/CSGTorus.xml

Update external links in:

  • docs/ExternalTexture.xml
  • docs/HTTPClient.xml
  • docs/OS.xml
  • docs/ProjectSettings.xml
  • docs/RandomNumberGenerator.xml
  • modules/webxr/docs/WebXRInterface.xml
  1. https://www.khronos.org/registry/ has been permanently redirected to https://registry.khronos.org/
  2. https://tools.ietf.org/html/ has been permanently redirected to https://datatracker.ietf.org/doc/html/
  3. https://bulletphysics.org has been permanently redirected to https://pybullet.org/wordpress/
  4. http://www.pcg-random.org/ is permanently redirected to https://www.pcg-random.org/
  5. https://developer.mozilla.org/en-US/docs/Web/API/ has permanent redirections:
    • XRReferenceSpaceType to XRSession/requestReferenceSpace
    • XRSessionMode to XRSystem/requestSession
    • XRVisibilityState to XRSession/visibilityState

Finally, in HTTPClient.xml, wrap http:// in code blocks to prevent it being detected as a broken URL link.

Fix broken internal Rebel Documentation links in:
- docs/Engine.xml
- docs/Node.xml
- modules/csg/docs/CSGBox.xml
- modules/csg/docs/CSGCombiner.xml
- modules/csg/docs/CSGCylinder.xml
- modules/csg/docs/CSGMesh.xml
- modules/csg/docs/CSGPolygon.xml
- modules/csg/docs/CSGPrimitive.xml
- modules/csg/docs/CSGShape.xml
- modules/csg/docs/CSGSphere.xml
- modules/csg/docs/CSGTorus.xml

Update external links in:
- docs/ExternalTexture.xml
- docs/HTTPClient.xml
- docs/OS.xml
- docs/ProjectSettings.xml
- docs/RandomNumberGenerator.xml
- modules/webxr/docs/WebXRInterface.xml

1. https://www.khronos.org/registry/ has been permanently
   redirected to https://registry.khronos.org/
2. https://tools.ietf.org/html/ has been permanently
   redirected to https://datatracker.ietf.org/doc/html/
3. https://bulletphysics.org has been permanently redirected
   to https://pybullet.org/wordpress/
4. http://www.pcg-random.org/ is permanently redirected to
   https://www.pcg-random.org/
5. https://developer.mozilla.org/en-US/docs/Web/API/ has
   permanent redirections:
   - XRReferenceSpaceType to XRSession/requestReferenceSpace
   - XRSessionMode        to XRSystem/requestSession
   - XRVisibilityState    to XRSession/visibilityState

In HTTPClient.xml, wrap http:// in code blocks to prevent it
being detected as a broken URL link.
@madmiraal madmiraal added the PR Type: Enhancement Your current game will work better. label Jul 21, 2024
@DanielaOrtner DanielaOrtner self-requested a review July 22, 2024 16:48
Copy link
Copy Markdown
Contributor

@DanielaOrtner DanielaOrtner left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for correcting the links!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

PR Type: Enhancement Your current game will work better.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants