Skip to content

Fix image loading issue in docs - #3978

Merged
GrantYu9 merged 2 commits into
UBC-Thunderbots:masterfrom
GrantYu9:grant_yu/fix_images_in_docs
Oct 6, 2026
Merged

GrantYu9 merged 2 commits into
UBC-Thunderbots:masterfrom
GrantYu9:grant_yu/fix_images_in_docs

Conversation

@GrantYu9

@GrantYu9 GrantYu9 commented Oct 5, 2026 •

Copy link
Copy Markdown
Member

Description

Background

Images had incorrect file paths in software-architecture-and-design.

Changes

Changed images/ to /docs/images in all image paths.

Length Justification and Key Files to Review

Let us be in /docs/. These files are of importance

  • /getting_started/editing-the-docs.md
  • /working_with_hardware/robot-software-architecture.md
  • /working_with_software/qt-best-practices.md
  • /working_with_software/software-architecture-and-design.md

Review Checklist

It is the reviewers responsibility to also make sure every item here has been covered

  • Function & Class comments: All function definitions (usually in the .h file) should have a javadoc style comment at the start of them. For examples, see the functions defined in thunderbots/software/geom. Similarly, all classes should have an associated Javadoc comment explaining the purpose of the class.
  • Remove all commented out code
  • Remove extra print statements: for example, those just used for testing
  • Resolve all TODO's: All TODO (or similar) statements should either be completed or associated with a github issue

Images had incorrect file paths in `software-architecture-and-design`.

@nycrat nycrat 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.

Nice catch! Glad to see someone reading the docs 😆

I think there are a few more instances of outdated image links, like for example in qt-best-practices.md so if you could also clean those up in this PR that would be great 🙏

@GrantYu9

GrantYu9 commented Oct 5, 2026

Copy link
Copy Markdown
Member Author

Nice catch! Glad to see someone reading the docs 😆

I think there are a few more instances of outdated image links, like for example in qt-best-practices.md so if you could also clean those up in this PR that would be great 🙏

Got it, will look into it!

Numerous documentation files linked with `images/` instead of
`/docs/images/`.

@nycrat nycrat 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.

👍

@GrantYu9
GrantYu9 merged commit 6cc6067 into UBC-Thunderbots:master Oct 6, 2026
14 of 15 checks passed
@GrantYu9
GrantYu9 deleted the grant_yu/fix_images_in_docs branch October 6, 2026 04:31
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.

3 participants