Auto docs using husky pre-commit

[gautam-divyanshu]

What kind of change does this PR introduce?

Issue Number:

Fixes #2970

Snapshots/Videos:

If relevant, did you update the documentation?

Summary

Does this PR introduce a breaking change?

Checklist

CodeRabbit AI Review

• I have reviewed and addressed all critical issues flagged by CodeRabbit AI
• I have implemented or provided justification for each non-critical suggestion
• I have documented my reasoning in the PR comments where CodeRabbit AI suggestions were not implemented

Test Coverage

• I have written tests for all new changes/features
• I have verified that test coverage meets or exceeds 95%
• I have run the test suite locally and all tests pass

Other information

Have you read the contributing guide?

[coderabbitai]

Important

Review skipped

More than 25% of the files skipped due to max files limit. The review is being skipped to prevent a low-quality review.

218 files out of 300 files are above the max files limit of 75. Please upgrade to Pro plan to get higher limits.

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

---

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

❤️ Share

• X
• Mastodon
• Reddit
• LinkedIn

🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

• Review comments: Directly reply to a review comment made by CodeRabbit. Example:
  • I pushed a fix in commit <commit_id>, please review it.
  • Generate unit testing code for this file.
  • Open a follow-up GitHub issue for this discussion.
• Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
  • @coderabbitai generate unit testing code for this file.
  • @coderabbitai modularize this function.
• PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
  • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
  • @coderabbitai read src/utils.ts and generate unit testing code.
  • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
  • @coderabbitai help me debug CodeRabbit configuration file.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

• @coderabbitai pause to pause the reviews on a PR.
• @coderabbitai resume to resume the paused reviews.
• @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
• @coderabbitai full review to do a full review from scratch and review all the files again.
• @coderabbitai summary to regenerate the summary of the PR.
• @coderabbitai generate docstrings to generate docstrings for this PR. (Beta)
• @coderabbitai resolve resolve all the CodeRabbit review comments.
• @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
• @coderabbitai help to get help.

Other keywords and placeholders

• Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
• Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
• Add @coderabbitai anywhere in the PR title to generate the title automatically.

Documentation and Community

• Visit our Documentation for detailed information on how to use CodeRabbit.
• Join our Discord Community to get help, request features, and share feedback.
• Follow us on X/Twitter for updates and announcements.

[github-actions]

Our Pull Request Approval Process

Thanks for contributing!

Testing Your Code

Remember, your PRs won't be reviewed until these criteria are met:

1. We don't merge PRs with poor code quality.
   1. Follow coding best practices such that CodeRabbit.ai approves your PR.
2. We don't merge PRs with failed tests.
   1. When tests fail, click on the Details link to learn more.
   2. Write sufficient tests for your changes (CodeCov Patch Test). Your testing level must be better than the target threshold of the repository
   3. Tests may fail if you edit sensitive files. Ask to add the ignore-sensitive-files-pr label if the edits are necessary.
3. We cannot merge PRs with conflicting files. These must be fixed.

Our policies make our code better.

Reviewers

Do not assign reviewers. Our Queue Monitors will review your PR and assign them.
When your PR has been assigned reviewers contact them to get your code reviewed and approved via:

1. comments in this PR or
2. our slack channel

Reviewing Your Code

Your reviewer(s) will have the following roles:

1. arbitrators of future discussions with other contributors about the validity of your changes
2. point of contact for evaluating the validity of your work
3. person who verifies matching issues by others that should be closed.
4. person who gives general guidance in fixing your tests

CONTRIBUTING.md

Read our CONTRIBUTING.md file. Most importantly:

1. PRs with issues not assigned to you will be closed by the reviewer
2. Fix the first comment in the PR so that each issue listed automatically closes

Other

1. 🎯 Please be considerate of our volunteers' time. Contacting the person who assigned the reviewers is not advised unless they ask for your input. Do not @ the person who did the assignment otherwise.
2. Read the CONTRIBUTING.md file make

[codecov]

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 89.74%. Comparing base (2490b2e) to head (f71e901).
Report is 14 commits behind head on develop-postgres.

Additional details and impacted files

@@                  Coverage Diff                  @@
##           develop-postgres    #3290       +/-   ##
=====================================================
+ Coverage              8.56%   89.74%   +81.18%     
=====================================================
  Files                   309      332       +23     
  Lines                  7954     8594      +640     
  Branches               1763     1901      +138     
=====================================================
+ Hits                    681     7713     +7032     
+ Misses                 7196      619     -6577     
- Partials                 77      262      +185     

Flag	Coverage Δ
combined	89.74% <ø> (?)
jest	8.42% <ø> (?)
vitest	89.74% <ø> (?)

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.

[palisadoes]

1. How does this look in the web UI?
2. The last time we saw too many references it README.md files
3. Is the pull request methodology working now?

[gautam-divyanshu]

@palisadoes

1. Test deployment is working now, so should I create new pr? I think new PR.
2. we tried generating docs and then deleting readme, but this is not working, there are lot of broken links, I will fix it.

[palisadoes]

1. A minor commit will rerun the workflow in this PR.
2. Focus on this PR

[gautam-divyanshu]

with readme:

without readme:

[gautam-divyanshu]

need to make few more changes

[palisadoes]

Let me know when this is ready.

Are you working with @bint-eve on this? It's best to have collaboration

[gautam-divyanshu]

Yes, we discussed a few things.

[palisadoes]

Is this working and ready to be merged?

[gautam-divyanshu]

@palisadoes The problem is that with every commit, the whole docs gets updated, and this shouldn't happen, but only those docs should get generated whose .tsx files are changed. so I'm fixing it.

[palisadoes]

See comments

[gautam-divyanshu]

@palisadoes I am just testing the workflow for now, will resolve these

[gautam-divyanshu]

@palisadoes having problems in commiting,

[palisadoes]

@palisadoes having problems in commiting,

It's referencing your repo not PalisadoesFoundation

[gautam-divyanshu]

@palisadoes i can merge using husky in this pr, I don't have to change much, scripts are same.

[palisadoes]

OK. It's reopened

[palisadoes]

You'll need to remove your changes to the GitHub action

[gautam-divyanshu]

@palisadoes @tasneemkoushar Ready for merge.

[palisadoes]

Should this be closed?

[gautam-divyanshu]

We can merge this, I have created a script to handle the broken links after Readme.md deletion. Fixed the test deployment workflow.

[palisadoes]

@gautam-divyanshu

1. Where can we put manually created files in docs/docs?
2. For example, we need an online version of INSTALLATION.md, possibly a CONFIGURING.md file too.
3. How would we make sure that the auto-docs is always below these files in the left nav?

[Rukhsarkh]

@gautam-divyanshu

1. Where can we put manually created files in docs/docs?
2. For example, we need an online version of INSTALLATION.md, possibly a CONFIGURING.md file too.
3. How would we make sure that the auto-docs is always below these files in the left nav?

Do we want like this ? @palisadoes

[gautam-divyanshu]

By default, Docusaurus generates a sidebar from the docs folder structure.

The sidebars.ts file controls the order and structure of items in the left-hand navigation. To ensure manually added files always appear above auto-generated files:

module.exports = {
  docs: [
    {
      type: 'category',
      label: 'Manual',
      items: [
        'INSTALLATION',  // Ensure this matches the filename without `.md`
        'CONFIGURING',
      ],
    },
    {
      type: 'autogenerated',
      dirName: '.',  // Automatically includes other docs from the root `docs/` folder
    },
  ],
};