Husky automation

[Suyash878]

What kind of change does this PR introduce?

Feature

Issue Number:

Fixes #2818

Snapshots/Videos:

If relevant, did you update the documentation?

Not sure.

Summary

Auto-generating the schema docs in /docs/docs/docs/schema.

Does this PR introduce a breaking change?

NA

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

NA

Have you read the contributing guide?

Yes

Summary by CodeRabbit

Release Notes

• Chores

  • Updated pre-commit hook to improve development workflow by adjusting command sequences and adding new commands.
  • Reorganized project scripts and import fixing processes.

• Documentation

  • Added comprehensive GraphQL schema documentation to improve developer understanding.

• Build

  • Updated build script paths to reflect new project structure.
  • Introduced a new script to automate documentation generation.

• New Features

  • Added a GitHub Actions workflow to automate the generation of GraphQL schemas.

These changes enhance project development processes and documentation, providing better clarity and workflow management.

Summary by CodeRabbit

• Documentation

  • The docs sidebar has been updated to feature a dedicated "Schema Documentation" category, offering improved organization and navigation.

• New Features

  • Introduced an automated process to correct Markdown links, ensuring they now route correctly to the documentation’s homepage.
  • Enhanced the documentation generation pipeline with updated tooling and configurations for a more streamlined build process.
  • New configuration files added for TypeScript and TypeDoc, improving documentation generation settings.

• Chores

  • Refined configuration settings to better manage file processing during documentation builds.
  • Updated dependencies to ensure compatibility and improved functionality.
  • Added entries to ignore specific directories in version control.
  • Upgraded TypeScript dependency version for improved performance.
  • Updated the .gitignore to exclude specific directories from version control.

[palisadoes]

Please fix the conflicting files

[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

[Suyash878]

Please review

[palisadoes]

@tasneemkoushar PTAL

[tasneemkoushar]

@Suyash878 I have cloned a test branch - test-schema-husky . It has exact same branch protection rule. Can you raise this PR to that branch first. We will get it merged there to verify the action, if works fine then we can again get the same PR for the develop-postgres branch

[Suyash878]

I have raised the PR, although it has a lot of conflicts.

[tasneemkoushar]

@Suyash878 try against this branch test-schema-husky-v2. You shouldn't get conflict this time

[Suyash878]

Done

[tasneemkoushar]

@Suyash878 merged your pr to that barnch, just monitor the changes and check if it behaves as expected

[Suyash878]

The changes are working as expected, I verified here's a screenshot for your reference:

This is ready to be merged.

[tasneemkoushar]

@Suyash878 LGTM but resolve the conflicts.

[tasneemkoushar]

@Suyash878 why 4 checks failing now?

[Suyash878]

I have resolved the conflicts. The 4 checks were failing since my package.json and pnpm-lock were not in sync, I have fixed that.

[palisadoes]

1. There is a new conflict. I just merged a PR.
2. Please fix

[Suyash878]

Done