Fix broken and incorrect links in the docs #5730
Conversation
|
|
||
| The cubemap primitive is used to create a [CubeTexture][cube-texture] environment map from 6 square images. | ||
|
|
||
| This can then be used as an [envMap](material.html#built_in_materials_envmap) in the [material component][material], or on a [probe light][probe-light]. |
There was a problem hiding this comment.
Despite #built_in_materials_envmap properly resolving in the docs, the docsLint.js script only allows references to headings found in the markdown. So I've changed it to point to #built-in-materials instead of the exact envMap property in the properties table.
| ## Applying an Image Texture | ||
|
|
||
| > Make sure you're [serving your HTML using a local server](../introduction/getting-started.md#using-a-local-server) | ||
| > Make sure you're [serving your HTML using a local server](../introduction/installation#use-a-local-server) |
There was a problem hiding this comment.
Is the link working without .md here?
There was a problem hiding this comment.
The link works in aframe-site, but it seems it doesn't with npm run docs. Will update it to include the .md file extension as that works in both environments.
Ideally both setups would behave identical. I've noticed more difference between the two, so I made the changes while testing in aframe-site.
|
Not sure if this is gonna work with the multiple versioning of the docs. Notice there are versions hardcoded. Gotta make sure we're not breaking the current system |
|
@dmarcos The links with hardcoded versions are the outliers and they don't work with multiple versions of the docs. They need to be bumped with each new version (example), and the In fact, they are currently broken when browsing the |
|
Yes. those are bumped manually. that's a decision make a long long time ago. Trying to understand why that was in place and if we can remove now without consequences |
|
Thank you! |
* Update aframe-environment-component to 1.5.x in examples and docs (#5674) * Fix broken links. (#5676) * Update aframe-physics-system to 4.2.3 in documentation (#5689) * Update contributing and introduction doc to point to Discord instead of Slack (#5690) * Update contributing doc to point to Discord instead of Slack * Remove newsletter and slack, add WebXR Discord to the introduction doc * Fix the npm search link and mention the A-Frame Wiki for an community-maintained list of components (#5695) * Fix minor error in documentation for reflection component (#5698) Fix a </a-scene> which is out of place. * Bump A-Frame version number in doc * fixed the anchored documentation error (#5711) in the anchored documentation, added function el.components.anchored.createAnchor(position, quaternion) instead of el.components.createAnchor(position, quaternion) * Update installation.md Python 3 command to `python3` (#5713) * Update installation.md Python 3 command to `python3` When following the instructions on macOS, after installing the recommended version of Python from python.org, I found that the Python 3 executable is `python3`, not `python`. Some quick internet searching suggests that `python3` is probably the most reliable command to run across multiple OSes. * Update installation.md * Use python3 command in visual-inspector-and-dev-tools.md (#5728) * Fix broken and incorrect links in the docs (#5730) * Update logitech-mx-ink-controls.md (#5742) fixing a minor typo with the logitech mx ink docs * Update some glitch links to examples inside the repo (#5744) * Point to aincraft in the repo instead of glitch * Remove not maintained networked-aframe glitch * Link to community-components in the repo instead of aframe-registry glitch * Replace a-watch glitch url by link in the repo * Replace glitch cdn url by aframe cdn for grip-compressed.glb * Remove cdn.glitch.com url in test * Link to 360-gallery in the repo instead of aframe-gallery glitch * Update link to Animated Lights example * Increase light intensity in dynamic-lights example * Remove dead examples in interactions-and-controllers * Add aframe-modify-model-material example in the repo * Remove dead Displacement Shader example --------- Co-authored-by: Diarmid Mackenzie <diarmid.mackenzie@gmail.com> Co-authored-by: Jesus M. Gonzalez-Barahona <jgb@gsyc.es> Co-authored-by: Diego Marcos Segura <diego.marcos@gmail.com> Co-authored-by: Vaibhavy <114183942+vaibhavyxx@users.noreply.github.com> Co-authored-by: Dan Jarvis <daj@users.noreply.github.com> Co-authored-by: Noeri Huisman <8823461+mrxz@users.noreply.github.com> Co-authored-by: Claudius Coenen <github@amenthes.de>
3 participants
Description:
I noticed an incorrect link on the
entity.mdpage, so decided to scan the docs for other broken/incorrect links and found several. This PR addresses a bunch of them, mostly the ones pointing to source files and other docs pages.There were also various external links that are now broken due to link rot. I've left these out of this PR, as they'll require more consideration (either remove, replace, update or link to an archived version).
Changes proposed: