Skip to content

docs: Fix broken links to the effects and bare Flame game pages - #4146

Merged
spydon merged 1 commit into
flame-engine:mainfrom
mmporong:fix-doc-links
Oct 27, 2026
Merged

spydon merged 1 commit into
flame-engine:mainfrom
mmporong:fix-doc-links

Conversation

@mmporong

Copy link
Copy Markdown
Contributor

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.md
  • tutorials/basic_shader/basic_shader.md: bare_flame_game.md → ../bare_flame_game.md
  • tutorials/platformer/step_4.md: both "docs" links pointed to ../../flame/effects.md#sizeeffectby. The SizeEffect one now points to ../../flame/effects/size_effects.md#sizeeffect-by, and the one in the paragraph about the water drop's MoveEffect.by now 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 .md link under doc/ for a target file and heading. markdownlint-cli2 with the repo's .markdownlint.yaml reports no issues on the three files.

Checklist

  • I have followed the Contributor Guide when preparing my PR.
  • [-] I have updated/added tests for ALL new/updated/fixed functionality.
  • I have updated/added relevant documentation in docs and added dartdoc comments with ///.
  • [-] I have updated/added relevant examples in examples or docs.

Breaking Change?

  • Yes, this PR is a breaking change.
  • No, this PR is not a breaking change.

Related Issues

@spydon spydon left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Thanks for your contribution

@spydon
spydon merged commit aee8f6f into flame-engine:main Oct 27, 2026
8 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants