Fix images in changelog not loading - #7202
Conversation
📝 WalkthroughWalkthroughThe PR updates changelog snippet formatting, adds unit-scoped balance examples, changes unit icon paths to relative paths, expands regex documentation, and revises several feature and fix entries. ChangesChangelog formatting
Estimated code review effort: 2 (Simple) | ~10 minutes Possibly related PRs
Suggested labels: Suggested reviewers: 🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
✨ Finishing Touches📝 Generate docstrings
🧪 Generate unit tests (beta)
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
There was a problem hiding this comment.
Actionable comments posted: 1
🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
Inline comments:
In `@docs/_plugins/balance_change.rb`:
- Line 17: Update the comment near the balance-list regex in balance_change.rb
to reference unit_block.rb as the implementation responsible for rendering the
unit icon and title, replacing the incorrect self-reference while leaving the
surrounding behavior unchanged.
🪄 Autofix
Fix all unresolved CodeRabbit comments on this PR:
- Push a commit to this branch (recommended)
- Create a new PR with the fixes
ℹ️ Review info
⚙️ Run configuration
Configuration used: defaults
Review profile: CHILL
Plan: Pro Plus
Run ID: dcacb297-9d7e-4370-8214-6566bde23500
📒 Files selected for processing (8)
changelog/snippets/balance.7121.mdchangelog/snippets/balance.7123.mdchangelog/snippets/features.7066.mdchangelog/snippets/features.7098.mdchangelog/snippets/other.7202.mddocs/_plugins/balance_change.rbdocs/_plugins/unit_block.rbdocs/development-changelog/balance-snippet.md
| # ending with a colon in the first line and having an arrow (-> in html) in | ||
| # the second. This is specific enough to not accidentally catch normal text or | ||
| # itemized lists. | ||
| # The unit icon and title is handled by balance_change.rb. |
There was a problem hiding this comment.
📐 Maintainability & Code Quality | 🟡 Minor | ⚡ Quick win
Point the comment to the correct plugin.
docs/_plugins/balance_change.rb applies the balance-list regex. docs/_plugins/unit_block.rb renders the unit icon and title. Update Line 17 so it references unit_block.rb; the current text directs maintainers to the wrong implementation.
🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
In `@docs/_plugins/balance_change.rb` at line 17, Update the comment near the
balance-list regex in balance_change.rb to reference unit_block.rb as the
implementation responsible for rendering the unit icon and title, replacing the
incorrect self-reference while leaving the surrounding behavior unchanged.
Description of the proposed changes
The unit icons for the balance changelog had a broken url, so they didn't load. See: https://faforever.github.io/fa/changelog/fafdevelop
While fixing this I also improved the documentation a little.
Testing done on the proposed changes
In the local environment the images still work, so hopefully they will now also work once we deploy the changes.
Additional context
@lL1l1 can you convert the rest of the balance snippets to the new format? I started doing it, but then I realized there is more important stuff that I should attend to and if I do it then other people don't learn to use the new format.
There are also non-balance snippets that still have the PR number at the start. Could you change these also? Most of them are yours anyway. You can just make a PR with all the changed snippets, then I will review it quickly.
Summary by CodeRabbit
Balance Updates
Bug Fixes
Features