feat(docs): ensure .md files are git tracked when generating sidebar

[joshuali925]

Description

This PR makes the sidebar docs generation to ignore markdown files that are not git tracked. Additionally it ignores lighthouse reports in /.lighthouseci/ directory.

Issues Resolved

I might have local markdown files that are not tracked by git, it won't make sense to put those in docs/_sidebar.

The sidebar generation only includes .md and it does not pick up .MD, .markdown, .MARKDOWN, etc. This is existing behavior.

Screenshot

Testing the changes

Changelog

• skip

Check List

• All tests pass
  • yarn test:jest
  • yarn test:jest_integration
• New functionality includes testing.
• New functionality has been documented.
• Update CHANGELOG.md
• Commits are signed per the DCO using --signoff

[codecov]

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 59.67%. Comparing base (93b471e) to head (f867900).
Report is 11 commits behind head on main.

Additional details and impacted files

@@           Coverage Diff           @@
##             main    #9891   +/-   ##
=======================================
  Coverage   59.67%   59.67%           
=======================================
  Files        4030     4030           
  Lines      102182   102182           
  Branches    16113    16113           
=======================================
+ Hits        60976    60980    +4     
+ Misses      37194    37191    -3     
+ Partials     4012     4011    -1     

Flag	Coverage Δ
Linux_1	27.56% <ø> (ø)
Linux_2	56.45% <ø> (ø)
Linux_3	38.29% <ø> (+<0.01%)	⬆️
Linux_4	29.01% <ø> (+<0.01%)	⬆️
Windows_1	27.57% <ø> (ø)
Windows_2	56.42% <ø> (ø)
Windows_3	38.29% <ø> (ø)
Windows_4	29.00% <ø> (ø)

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 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.

[kavilla]

Thank you so much for doing this!!!! I keep ignoring this commit hook. So this will make life better

Just a comment tho. If we should use git status instead

[kavilla]

Should this check the status? Like

Suggested change

	execSync(`git ls-files '*.md'`).toString().trim().split('\n').filter(Boolean)
	execSync(`git status -s '*.md'`)

And if the file is unstaged it will have a space as the first character. In other words:
A file is staged if the first letter is not a space.

That way once we stage the markdown file and trying to commit then it will generate

[joshuali925]

The script builds the sidebar using all md files, not just the modified ones in the current commit. git status -s only returns information in the git working tree and staging area, so if I see a a.md file on disk but it's not part of the git status output, I won't be able to tell if it's already tracked by git and should be included in the sidebar, or if it's part of .gitignore and should be excluded.

If you do git add new.md; git rm existing.md, ls-files will include new.md but not existing.md, so this should work properly. I think we can directly use git ls-files results to build the sidebar instead of manual traversal, but there is some logic for path prefix and not really any benefit to refactor this

(BTW git status --porcelain works better if you ever need it in scripts, and git diff --name-only --cached --diff-filter=A returns the files added in staging area)