[HelpDot] Fix List Spacing in Expensify Help #47200

rushatgabhane · 2024-08-11T14:43:07Z

Details

Fixed Issues

$ #44107
PROPOSAL:

Tests

cd docs && npm run createDocsRoutes && bundle exec jekyll serve --livereload --safe
Go to http://127.0.0.1:4000/articles/expensify-classic/connections/xero/Configure-Xero
Verify that nested list items dont have spacing below them

Verify that no errors appear in the JS console

Offline tests

QA Steps

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: mWeb Chrome
- iOS: Native
- iOS: mWeb 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 either coming verbatim from figma or has been approved by marketing (in order to get marketing approval, ask the Bug Zero team member to add the Waiting for copy label to the issue)
- 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 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(theme.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 the PR modifies the UI (e.g. new buttons, new UI components, changing the padding/spacing/sizing, moving components, etc) or modifies the form input styles:
- I verified that all the inputs inside a form are aligned with each other.
- I added Design label and/or tagged @Expensify/design so the design team can review the changes.
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.

Screenshots/Videos

melvin-bot · 2024-08-11T14:43:12Z

@aimane-chnaif Please 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]

rushatgabhane · 2024-08-11T14:58:23Z

@shawnborton line height comparison.
I added line height to the whole article. Is that what you were expecting?

Current line height	1.33 line height	20px line height

rushatgabhane · 2024-08-11T15:11:53Z

@aimane-chnaif kindly approve to assign internal

dangrous

Looks good to me assuming @Expensify/design is good with it!

dangrous · 2024-08-12T14:55:25Z

Reviewer Checklist

I have verified the author checklist is complete (all boxes are checked off).
I verified the correct issue is linked in the ### Fixed Issues section above
I verified testing steps are clear and they cover the changes made in this PR
- I verified the steps for local testing are in the Tests section
- I verified the steps for Staging and/or Production testing are in the QA steps section
- I verified the steps cover any possible 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 checked that screenshots or videos are included for tests on all platforms
I included screenshots or videos for tests on all platforms
I verified tests pass on all platforms & I tested again on:
- Android: Native
- Android: mWeb Chrome
- iOS: Native
- iOS: mWeb Safari
- MacOS: Chrome / Safari
- MacOS: Desktop
If there are any errors in the console that are unrelated to this PR, I either fixed them (preferred) or linked to where I reported them in Slack
I verified proper code patterns were followed (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
- 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 either coming verbatim from figma or has been approved by marketing (in order to get marketing approval, ask the Bug Zero team member to add the Waiting for copy label to the issue)
- 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 verified that this PR follows the guidelines as stated in the Review Guidelines
I verified other components that can be impacted by these changes have been tested, and I retested again (i.e. if the PR modifies a shared library or component like Avatar, I verified the components using Avatar have been tested & I retested again)
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
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
- For Class Components, any internal methods passed to components event handlers are bound to this properly so there are no scoping issues (i.e. for onClick={this.submit} the method this.submit should be bound to this in the constructor)
- 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(theme.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 the PR modifies the UI (e.g. new buttons, new UI components, changing the padding/spacing/sizing, moving components, etc) or modifies the form input styles:
- I verified that all the inputs inside a form are aligned with each other.
- I added Design label and/or tagged @Expensify/design so the design team can review the changes.
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 reviewer 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

shawnborton · 2024-08-12T15:00:48Z

Yeah - 1.33 is pretty close to 20px when we have 15px font. So it might be safe to just use 1.33 as the size-wide line height, though I can see an argument to tighten up the line height on bigger headlines. How does something like that sound?

rushatgabhane · 2024-08-27T15:21:36Z

So it might be safe to just use 1.33 as the size-wide line height

@shawnborton sorry do you mean that we should 1.33 as the line height for the entire help site?

shawnborton · 2024-08-27T15:22:31Z

That is my thinking, and then things like headlines might override that with a tighter line height.

rushatgabhane · 2024-09-17T19:15:02Z

Line height 1.33 on entire page vs existing 1.4 -

1.33	Existing - 1.4

rushatgabhane · 2024-09-17T19:17:45Z

@shawnborton Let me know if 1.33 looks okay. I will push the changes

shawnborton · 2024-09-17T20:47:41Z

I think it looks okay to me! Let's make sure @Expensify/design agrees too.

shawnborton · 2024-09-17T20:48:23Z

@rushatgabhane can you do something like 1.2 line height for h1/h2/h3 as well?

dubielzyk-expensify · 2024-09-18T02:57:43Z

LGTM

dangrous · 2024-09-24T16:23:22Z

Bumping this one comment but then I think we'll be ready to go!

@rushatgabhane can you do something like 1.2 line height for h1/h2/h3 as well?

rushatgabhane · 2024-09-30T02:35:23Z

im running into trouble running the helpsite. related to ruby version i think

trying again today

dangrous · 2024-10-10T15:21:00Z

bumping this when you have a sec @rushatgabhane - hopefully should be pretty quick

dangrous · 2024-10-15T15:07:24Z

@rushatgabhane do you think you can knock out those line height changes this week?

dangrous · 2024-10-25T17:50:29Z

bump ^

rushatgabhane · 2024-10-28T01:55:15Z

helpdot stopped building 😕

looks like ruby version needs to be downgraded

dangrous · 2024-10-28T18:36:20Z

hrm you're actually getting further than I am - I get stuck on bundle install:

An error occurred while installing ffi (1.15.5), and Bundler cannot continue.

In Gemfile:
  jekyll-feed was resolved to 0.15.1, which depends on
    jekyll was resolved to 3.9.3, which depends on
      jekyll-sass-converter was resolved to 1.5.2, which depends on
        sass was resolved to 3.7.4, which depends on
          sass-listen was resolved to 4.0.0, which depends on
            rb-inotify was resolved to 0.10.1, which depends on
              ffi

EDIT: pinged in Slack for assistance, let's see!

dangrous · 2024-10-29T20:17:14Z

@rushatgabhane I think this is only a temporary fix but it'll get this PR across the line - run bundle update in docs and it should work.

dangrous · 2024-11-01T17:41:37Z

let me know if that works for you @rushatgabhane! We shouldn't commit the changes to the gemfile since the issues seem dev-only (maybe need to make another issue for the future) but should help us test this

dangrous · 2024-11-05T16:17:42Z

@rushatgabhane let us know if you can knock out that change - this has been sitting for a long time :)

rushatgabhane · 2024-11-10T20:28:21Z

updated @shawnborton

shawnborton · 2024-11-11T09:01:55Z

That feels pretty good to me, cc @Expensify/design for viz.

dangrous

wooo, thanks for this!

github-actions · 2024-11-11T18:38:56Z

🚀 Deployed to staging by https://github.com/dangrous in version: 9.0.60-0 🚀

platform	result
🤖 android 🤖	success ✅
🖥 desktop 🖥	success ✅
🍎 iOS 🍎	success ✅
🕸 web 🕸	success ✅
🤖🔄 android HybridApp 🤖🔄	success ✅
🍎🔄 iOS HybridApp 🍎🔄	success ✅

github-actions · 2024-11-13T00:42:25Z

🚀 Deployed to production by https://github.com/francoisl in version: 9.0.60-3 🚀

platform	result
🤖 android 🤖	success ✅
🖥 desktop 🖥	success ✅
🍎 iOS 🍎	success ✅
🕸 web 🕸	success ✅
🤖🔄 android HybridApp 🤖🔄	skipped 🚫
🍎🔄 iOS HybridApp 🍎🔄	skipped 🚫

rm padding from nested list

58833a1

rushatgabhane requested a review from a team as a code owner August 11, 2024 14:43

melvin-bot bot requested review from aimane-chnaif and removed request for a team August 11, 2024 14:43

rushatgabhane changed the title ~~rm padding from nested list~~ [HelpDot] Fix List Spacing in Expensify Help Aug 11, 2024

add 4px padding to li

6e03be6

aimane-chnaif approved these changes Aug 12, 2024

View reviewed changes

melvin-bot bot requested a review from dangrous August 12, 2024 04:28

dangrous previously approved these changes Aug 12, 2024

View reviewed changes

Merge branch 'Expensify:main' into margin

b78c74b

rushatgabhane added 2 commits November 11, 2024 01:46

Merge branch 'main' into margin

8320129

add line height 1.2 for h1 h2 h3

afd6277

rushatgabhane dismissed dangrous’s stale review via afd6277 November 10, 2024 20:22

line height 1.33 for page

0ef4a53

dangrous approved these changes Nov 11, 2024

View reviewed changes

dangrous merged commit 6103185 into Expensify:main Nov 11, 2024
9 checks passed

github-actions bot mentioned this pull request Nov 11, 2024

[HOLD for payment 2024-11-21] Deploy Checklist: New Expensify 2024-11-11 #52320

Closed

95 tasks

melvin-bot bot mentioned this pull request Nov 13, 2024

[HOLD for payment 2024-11-20] Fix List Spacing in Expensify Help #44107

Closed

6 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[HelpDot] Fix List Spacing in Expensify Help #47200

[HelpDot] Fix List Spacing in Expensify Help #47200

rushatgabhane commented Aug 11, 2024

melvin-bot bot commented Aug 11, 2024

rushatgabhane commented Aug 11, 2024 •

edited

Loading

rushatgabhane commented Aug 11, 2024

dangrous left a comment

dangrous commented Aug 12, 2024 •

edited

Loading

shawnborton commented Aug 12, 2024

rushatgabhane commented Aug 27, 2024

shawnborton commented Aug 27, 2024

rushatgabhane commented Sep 17, 2024 •

edited

Loading

rushatgabhane commented Sep 17, 2024 •

edited

Loading

shawnborton commented Sep 17, 2024

shawnborton commented Sep 17, 2024

dubielzyk-expensify commented Sep 18, 2024

dangrous commented Sep 24, 2024

rushatgabhane commented Sep 30, 2024

dangrous commented Oct 10, 2024

dangrous commented Oct 15, 2024

dangrous commented Oct 25, 2024

rushatgabhane commented Oct 28, 2024 •

edited

Loading

dangrous commented Oct 28, 2024 •

edited

Loading

dangrous commented Oct 29, 2024

dangrous commented Nov 1, 2024

dangrous commented Nov 5, 2024

rushatgabhane commented Nov 10, 2024

shawnborton commented Nov 11, 2024

dangrous left a comment

github-actions bot commented Nov 11, 2024

github-actions bot commented Nov 13, 2024

[HelpDot] Fix List Spacing in Expensify Help #47200

[HelpDot] Fix List Spacing in Expensify Help #47200

Conversation

rushatgabhane commented Aug 11, 2024

Details

Fixed Issues

Tests

Offline tests

QA Steps

PR Author Checklist

Screenshots/Videos

melvin-bot bot commented Aug 11, 2024

rushatgabhane commented Aug 11, 2024 • edited Loading

rushatgabhane commented Aug 11, 2024

dangrous left a comment

Choose a reason for hiding this comment

dangrous commented Aug 12, 2024 • edited Loading

Reviewer Checklist

Screenshots/Videos

shawnborton commented Aug 12, 2024

rushatgabhane commented Aug 27, 2024

shawnborton commented Aug 27, 2024

rushatgabhane commented Sep 17, 2024 • edited Loading

rushatgabhane commented Sep 17, 2024 • edited Loading

shawnborton commented Sep 17, 2024

shawnborton commented Sep 17, 2024

dubielzyk-expensify commented Sep 18, 2024

dangrous commented Sep 24, 2024

rushatgabhane commented Sep 30, 2024

dangrous commented Oct 10, 2024

dangrous commented Oct 15, 2024

dangrous commented Oct 25, 2024

rushatgabhane commented Oct 28, 2024 • edited Loading

dangrous commented Oct 28, 2024 • edited Loading

dangrous commented Oct 29, 2024

dangrous commented Nov 1, 2024

dangrous commented Nov 5, 2024

rushatgabhane commented Nov 10, 2024

shawnborton commented Nov 11, 2024

dangrous left a comment

Choose a reason for hiding this comment

github-actions bot commented Nov 11, 2024

github-actions bot commented Nov 13, 2024

rushatgabhane commented Aug 11, 2024 •

edited

Loading

dangrous commented Aug 12, 2024 •

edited

Loading

rushatgabhane commented Sep 17, 2024 •

edited

Loading

rushatgabhane commented Sep 17, 2024 •

edited

Loading

rushatgabhane commented Oct 28, 2024 •

edited

Loading

dangrous commented Oct 28, 2024 •

edited

Loading