chore: add doc format and install dependency

[Jay-ju]

Changes Made

Goal 1: When making docs, directly include relevant dependencies to prevent errors during runtime.
Goal 2: Added formatting for mkdocs.yml.

Related Issues

Checklist

• Documented in API Docs (if applicable)
• Documented in User Guide (if applicable)
• If adding a new documentation page, doc is added to docs/mkdocs.yml navigation
• Documentation builds and is formatted properly (tag @/ccmao1130 for docs review)

[Jay-ju]

@colin-ho @ccmao1130 If you have time, please take a look at this PR. It's mainly about documentation - related content. Thanks.

[codecov]

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 78.27%. Comparing base (31370fb) to head (0030d01).
Report is 22 commits behind head on main.

Additional details and impacted files

@@            Coverage Diff             @@
##             main    #4741      +/-   ##
==========================================
+ Coverage   78.12%   78.27%   +0.14%     
==========================================
  Files         873      877       +4     
  Lines      121840   123659    +1819     
==========================================
+ Hits        95184    96788    +1604     
- Misses      26656    26871     +215     

see 75 files with indirect coverage changes

🚀 New features to boost your workflow:

• ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
• 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

[kevinzwang]

@ccmao1130 could you take a look at this?

[ccmao1130]

Hey @Jay-ju, thanks for opening this PR! The mkdocs.yml and additional make step and dependencies make sense. The only thing I want to push back on is deleting Docsearch because we wanted to integrate Algolia Docsearch instead of the native Mkdocs search for our documentation.

I can look into how we can improve our search crawler to reflect local searches

[ccmao1130]

@kevinzwang do these make sense to add?

[kevinzwang]

We don't have any yaml files in our docs afaik so let's not add these

[Jay-ju]

mkdocs.yml is yaml file

[kevinzwang]

That is true. If you'd like to lint that file though, could we add a linting step to the .pre-commit-config.yaml instead? It looks like yamllint is a supported hook

[Jay-ju]

It seems that the .pre-commit-config.yaml file has some default configurations, and it can also be checked in precommit currently. I'm not sure if I need to define a separate YAML format file.

[kevinzwang]

It's ok, we can worry about it some other time. In the mean time let's just not add these dependencies since they aren't explicitly used anywhere

[Jay-ju]

- id: check-yaml There seems to be a check here, but it doesn't seem to be taking effect. However, I guess it's because the mkdocs.yml is relatively newly created and this check hasn't been implemented.

[Jay-ju]

@ccmao1130 @kevinzwang Do you think an update is still needed? Please take a look when you have time.