Repository navigation
docs: Fix broken links to the effects and bare Flame game pages - #4146
Merged
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Description
Four doc links point to files that do not exist, so Sphinx renders them as dead in-page anchors on docs.flame-engine.org. For example, the camera page links to
href="#effects.md".flame/camera.md:effects.md→effects/effects.mdtutorials/basic_shader/basic_shader.md:bare_flame_game.md→../bare_flame_game.mdtutorials/platformer/step_4.md: both "docs" links pointed to../../flame/effects.md#sizeeffectby. TheSizeEffectone now points to../../flame/effects/size_effects.md#sizeeffect-by, and the one in the paragraph about the water drop'sMoveEffect.bynow points to../../flame/effects/move_effects.md#movebyeffect. The anchors are the ids the live pages use. I rewrapped the first of these lines to stay within the 100-character limit.I found them by checking every relative
.mdlink underdoc/for a target file and heading.markdownlint-cli2with the repo's.markdownlint.yamlreports no issues on the three files.Checklist
docsand added dartdoc comments with///.examplesordocs.Breaking Change?
Related Issues