Fixing image that isn't displaying properly.

[strepanier03]

Explanation of Change

Tryin to fix the display of the image added to this doc. From here - https://github.com/Expensify/Expensify/issues/439560

Fixed Issues

$
PROPOSAL:

Tests

• Verify that no errors appear in the JS console

Offline tests

QA Steps

// TODO: These must be filled out, or the issue title must include "[No QA]."

• Verify that no errors appear in the JS console

PR Author Checklist

• I linked the correct issue in the ### Fixed Issues section above
• I wrote clear testing steps that cover the changes made in this PR
  • I added steps for local testing in the Tests section
  • I added steps for the expected offline behavior in the Offline steps section
  • I added steps for Staging and/or Production testing in the QA steps section
  • I added steps to cover failure scenarios (i.e. verify an input displays the correct error message if the entered data is not correct)
  • I turned off my network connection and tested it while offline to ensure it matches the expected behavior (i.e. verify the default avatar icon is displayed if app is offline)
  • I tested this PR with a High Traffic account against the staging or production API to ensure there are no regressions (e.g. long loading states that impact usability).
• I included screenshots or videos for tests on all platforms
• I ran the tests on all platforms & verified they passed on:
  • Android / native
  • Android / Chrome
  • iOS / native
  • iOS / Safari
  • MacOS / Chrome / Safari
  • MacOS / Desktop
• I verified there are no console errors (if there's a console error not related to the PR, report it or open an issue for it to be fixed)
• I followed proper code patterns (see Reviewing the code)
  • I verified that any callback methods that were added or modified are named for what the method does and never what callback they handle (i.e. toggleReport and not onIconClick)
  • I verified that the left part of a conditional rendering a React component is a boolean and NOT a string, e.g. myBool && <MyComponent />.
  • I verified that comments were added to code that is not self explanatory
  • I verified that any new or modified comments were clear, correct English, and explained "why" the code was doing something instead of only explaining "what" the code was doing.
  • I verified any copy / text shown in the product is localized by adding it to src/languages/* files and using the translation method
    • If any non-english text was added/modified, I verified the translation was requested/reviewed in #expensify-open-source and it was approved by an internal Expensify engineer. Link to Slack message:
  • I verified all numbers, amounts, dates and phone numbers shown in the product are using the localization methods
  • I verified any copy / text that was added to the app is grammatically correct in English. It adheres to proper capitalization guidelines (note: only the first word of header/labels should be capitalized), and is approved by marketing by adding the Waiting for Copy label for a copy review on the original GH to get the correct copy.
  • I verified proper file naming conventions were followed for any new files or renamed files. All non-platform specific files are named after what they export and are not named "index.js". All platform-specific files are named for the platform the code supports as outlined in the README.
  • I verified the JSDocs style guidelines (in STYLE.md) were followed
• If a new code pattern is added I verified it was agreed to be used by multiple Expensify engineers
• I followed the guidelines as stated in the Review Guidelines
• I tested other components that can be impacted by my changes (i.e. if the PR modifies a shared library or component like Avatar, I verified the components using Avatar are working as expected)
• I verified all code is DRY (the PR doesn't include any logic written more than once, with the exception of tests)
• I verified any variables that can be defined as constants (ie. in CONST.js or at the top of the file that uses the constant) are defined as such
• I verified that if a function's arguments changed that all usages have also been updated correctly
• If a new component is created I verified that:
  • A similar component doesn't exist in the codebase
  • All props are defined accurately and each prop has a /** comment above it */
  • The file is named correctly
  • The component has a clear name that is non-ambiguous and the purpose of the component can be inferred from the name alone
  • The only data being stored in the state is data necessary for rendering and nothing else
  • If we are not using the full Onyx data that we loaded, I've added the proper selector in order to ensure the component only re-renders when the data it is using changes
    • Any internal methods bound to this are necessary to be bound (i.e. avoid this.submit = this.submit.bind(this); if this.submit is never passed to a component event handler like onClick)
  • All JSX used for rendering exists in the render method
  • The component has the minimum amount of code necessary for its purpose, and it is broken down into smaller components in order to separate concerns and functions
• If any new file was added I verified that:
  • The file has a description of what it does and/or why is needed at the top of the file if the code is not self explanatory
• If a new CSS style is added I verified that:
  • A similar style doesn't already exist
  • The style can't be created with an existing StyleUtils function (i.e. StyleUtils.getBackgroundAndBorderStyle(themeColors.componentBG))
• If the PR modifies code that runs when editing or sending messages, I tested and verified there is no unexpected behavior for all supported markdown - URLs, single line code, code blocks, quotes, headings, bold, strikethrough, and italic.
• If the PR modifies a generic component, I tested and verified that those changes do not break usages of that component in the rest of the App (i.e. if a shared library or component like Avatar is modified, I verified that Avatar is working as expected in all cases)
• If the PR modifies a component related to any of the existing Storybook stories, I tested and verified all stories for that component are still working as expected.
• If the PR modifies a component or page that can be accessed by a direct deeplink, I verified that the code functions as expected when the deeplink is used - from a logged in and logged out account.
• If a new page is added, I verified it's using the ScrollView component to make it scrollable when more elements are added to the page.
• If the main branch was merged into this PR after a review, I tested again and verified the outcome was still expected according to the Test steps.
• I have checked off every checkbox in the PR author checklist, including those that don't apply to this PR.

Screenshots/Videos

Android: Native

Android: mWeb Chrome

iOS: Native

iOS: mWeb Safari

MacOS: Chrome / Safari

MacOS: Desktop

[strepanier03]

Waiting for the build and then I'll review to see if the image is working.

[melvin-bot]

Concierge reviewer checklist:

• I have verified the accuracy of the article
  • The article is within a hub that makes sense, and the navigation is correct
  • All processes, screenshots, and examples align with current product behavior.
  • All links within the doc have been verified for correct destination and functionality.
• I have verified the readability of the article
  • The article's language is clear, concise, and free of jargon.
  • The grammar, spelling, and punctuation are correct.
  • The article contains at least one image, or that an image is not necessary
• I have verified the formatting of the article
  • The article has consistent formatting (headings, bullet points, etc.) with other HelpDot articles and that aligns with the HelpDot formatting standards.
  • The article has proper text spacing and breaks for readability.
• I have verified the article has the appropriate tone and style
  • The article's tone is professional, friendly, and suitable for the target audience.
  • The article's tone, terminology, and voice are consistent throughout.
• I have verified the overall quality of the article
  • The article is not missing any information, nor does it contain redundant information.
  • The article fully addresses user needs.
• I have verified that all requested improvements have been addressed

For more detailed instructions on completing this checklist, see How do I review a HelpDot PR as a Concierge Team member?

cc @jliexpensify

[melvin-bot]

@NikkiWines @jliexpensify One of you needs to copy/paste the Reviewer Checklist from here into a new comment on this PR and complete it. If you have the K2 extension, you can simply click: [this button]

[OSBotify]

A preview of your ExpensifyHelp changes have been deployed to https://39744ad0.helpdot.pages.dev ⚡️

[strepanier03]

Hmmm, still broken. I'll try again.

[strepanier03]

Okay made a change, trying again.

[strepanier03]

🤔 - still broken and I don't know why.

[NikkiWines]

@strepanier03 I don't think we want to inlcude the .vscode/settings.json file that's been added

[strepanier03]

@NikkiWines - I'm not even sure how that got added, I definitely didn't do it manually. Maybe it's my github.dev, it's been acting really funny the last week with connection errors.

I removed it and am letting the build go again. If it doesn't work then I think I might close this and start over entirely.

[NikkiWines]

@strepanier03 I'm happy to help out here too if you want me to take it over

[jliexpensify]

I'm guessing I shoudl wait for the Concierge review?

[strepanier03]

@NikkiWines - I'd love to learn how to fix the image issue and why it won't load the image from the repo on th site or in the build.

This only happens if I try to add the image to the help doc in the same PR I add it to the repo. I normally don't do it in one PR but was asked to for testing purposes and to see if it was possible.

[NikkiWines]

@strepanier03 it looks like the format of the image file isn't correct in GH. If you go to https://github.com/Expensify/App/blob/main/docs/assets/images/Edit_Photo.png you can see the image isn't rendering correctly in GH even on main, so it's not tied to the changes in this PR (which I guess is obvious since you're making this PR to fix the initial issue).

It looks like we might need to delete the old image and re-upload a new one (we can do that as part of this PR), maybe the rename caused issues

[NikkiWines]

Also looks like the .vscode/settings.json file is still in the PR, we should delete that 👍

[NikkiWines]

Ok, it's a little weird using Github's UI, so I made a video on how to add and delete the photo on your branch - hopefully this helps!

Screen.Recording.2025-02-27.at.23.34.29.mov

[strepanier03]

Thank you @NikkiWines I will tackle this tomorrow. I really appreciate your help understanding how to correct this and for you taking the time to teach me.

[NikkiWines]

Gonna snag this one to get it finished real quick!

[NikkiWines]

I don't know how to get it to regenerate the preview for the help site, but it should be all good now!

https://github.com/Expensify/App/blob/strepanier03-editphoto-fix/docs/assets/images/Edit_Photo.png <- this now shows the photo rendering correctly 🎊

She committed code to the PR so I'll take over review

[amyevans]

https://github.com/Expensify/App/blob/strepanier03-editphoto-fix/docs/assets/images/Edit_Photo.png <- this now shows the photo rendering correctly 🎊

Things look good there! Although from the code review pane it's saying Invalid image source. 🤔 Not really sure if that's a lie or the truth haha but either way it's not going to be more broken than it was before. So let's give it a shot!