[TS migration] Migrate 'Docs' files to TypeScript

[VickyStash]

Details

[TS migration] Migrate 'Docs' files to TypeScript

Fixed Issues

$ #25358
PROPOSAL: N/A

Tests

• Verify that no errors appear in the JS console

1. Launch docs (cd docs && npm run createDocsRoutes && bundle exec jekyll serve --livereload)
2. Verify that docs look and work as before.
3. Go through different articles using the sidebar.
4. Go through different articles using tabs (tile bar)
5. Try to find an article using search, and verify it works as expected.
6. Test desktop/mobile selector:
   6.1 Go to Expensify Classic > Getting Started > Join Your Company's Workspace
   6.2 Verify that the desktop selector is selected by default
   6.3 Click the selector and change the value to Mobile.
   6.4 Verify that the content changes and shows content related to mobile.
   6.5 Verify that all other selectors in the page are in sync and are selected to mobile.

Offline tests

N/A

QA Steps

• Verify that no errors appear in the JS console

Same as in the Tests section

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 explxanatory
• 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 form input styles:
  • I verified that all the inputs inside a form are aligned with each other.
  • I added Design label 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

Docs

Docs1.mp4

[VickyStash]

Note: deploy part of the integration flow is expected to fail, comment from another PR

[fabioh8010]

just curious: why doesn't it work?

[VickyStash]

@fabioh8010 It gives this error

[blazejkustra]

Maybe we should disable this rule?

[VickyStash]

Do you mean on the file level?

[VickyStash]

I have looked through the app and there are not a lot of places where this eslint rule causes problems. Also, this case is kind of specific due to the used data, so I think it's okay to leave it as is

[blazejkustra]

Okay, let's leave it as is 😄

[blazejkustra]

Deploy ExpensifyHelp / build (pull_request) check is failing 🤔

[VickyStash]

Deploy ExpensifyHelp / build (pull_request) check is failing 🤔

@blazejkustra see my comment

[melvin-bot]

@parasharrajat 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]

[parasharrajat]

Noticing a navigation issue. Is it expected? Am I missing something from the test steps?

1. Navigation is frozen on the Preference page.

Screen.Recording.2024-03-13.at.11.24.06.PM.mov

[VickyStash]

@parasharrajat I've re-run Docs from scratch and I was able to reproduce the issue you have mentioned. I think I haven't noticed it initially due to the local cache when tested it on my own 😞
I've made some investigations and the reason for the problem is that these files are injected into layout html. Overall the docs folder structure is required by jekyll. It looks like jekyll doesn't support ts compiling, I saw some plugins, but they are old/outdated, so it feels like it isn't worth it.
I think I'm going to close this PR.

[parasharrajat]

I think it is fine but let's raise this in Slack first.

[VickyStash]

@parasharrajat I haven't got any feedback in Slack, I'll wait till EOD and then close the PR/issue. What do you think?

[parasharrajat]

Works for me. Thanks.