Added script to generate table of content

[Veer0x1]

What kind of change does this PR introduce?
This PR adds a script generate:toc to automatically generate table of contents for all the makrdown files in repository, for this command to work, there should we a comment of <!-- toc --> and <!-- tocstop -->. The table of content will be place under this comments. If this comments aren't present in any markdown file then there will be no change in those files.
I have placed this comments in all the neccessary markdown files. This done via a markdow-toc npm package. I have also added instruction on how to use this script in CONTRIBUTING.md file

Issue Number:

Fixes #1528

Did you add tests for your changes?

Snapshots/Videos:

If relevant, did you update the documentation?

Summary

Does this PR introduce a breaking change?

Other information

Have you read the contributing guide?

[github-actions]

Our Pull Request Approval Process

We have these basic policies to make the approval process smoother for our volunteer team.

Testing Your Code

Please make sure your code passes all tests. Our test code coverage system will fail if these conditions occur:

1. The overall code coverage drops below the target threshold of the repository
2. Any file in the pull request has code coverage levels below the repository threshold
3. Merge conflicts

The process helps maintain the overall reliability of the code base and is a prerequisite for getting your PR approved. Assigned reviewers regularly review the PR queue and tend to focus on PRs that are passing.

Reviewers

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

Attention: 151 lines in your changes are missing coverage. Please review.

Comparison is base (c0468a4) 98.17% compared to head (2a06ad4) 97.00%.
Report is 113 commits behind head on develop.

Files	Patch %	Lines
src/scripts/githooks/generate-toc.js	0.00%	60 Missing ⚠️
src/utilities/PII/decryption.ts	0.00%	17 Missing ⚠️
src/resolvers/Mutation/updateUserProfile.ts	70.90%	1 Missing and 15 partials ⚠️
src/resolvers/middleware/currentUserExists.ts	45.83%	13 Missing ⚠️
src/utilities/PII/encryption.ts	0.00%	13 Missing ⚠️
src/utilities/PII/isAuthorised.ts	0.00%	11 Missing ⚠️
...tilities/encodedVideoStorage/uploadEncodedVideo.ts	90.12%	8 Missing ⚠️
src/resolvers/Mutation/createPost.ts	86.95%	6 Missing ⚠️
src/resolvers/Mutation/removeAdvertisement.ts	92.85%	2 Missing ⚠️
...c/resolvers/Query/postsByOrganizationConnection.ts	33.33%	2 Missing ⚠️
... and 2 more

Additional details and impacted files

@@             Coverage Diff             @@
##           develop    #1587      +/-   ##
===========================================
- Coverage    98.17%   97.00%   -1.17%     
===========================================
  Files          184      215      +31     
  Lines        10767    13009    +2242     
  Branches       835     1042     +207     
===========================================
+ Hits         10571    12620    +2049     
- Misses         186      359     +173     
- Partials        10       30      +20     

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

[palisadoes]

See comment

[palisadoes]

See comment

[Veer0x1]

@palisadoes added git hook

[palisadoes]

I thought about the universality of this solution. Will it work for developers running on the most OS platforms?

1. Windows
2. Mac
3. Linux

For example, the find command is Unix specific

[Veer0x1]

I thought about the universality of this solution. Will it work for developers running on the most OS platforms?

1. Windows
2. Mac
3. Linux

For example, the find command is Unix specific

It's my bad; I forgot to consider Windows; the find command will work for Unix-based Operating systems only, so to make it more universal, we could write a TypeScript file, which will find the markdown files using Node.js's files system. Or if you have any other approach, please suggest.

[palisadoes]

1. Yes typescript works.
2. Please the script in the scriptsdirectory. Under a dedicated githookssub directory to make it very obvious.
3. Move any other scripts used by hooks there too

[palisadoes]

We have a similar PR open in Admin. Javascript was selected for the reason stated here

• Feature : Added markdown-toc package to auto-generate toc with husky pre commit hook. talawa-admin#1280 (comment)

[Veer0x1]

We have a similar PR open in Admin. Javascript was selected for the reason stated here

• Feature : Added markdown-toc package to auto-generate toc with husky pre commit hook. talawa-admin#1280 (comment)

Thanks for suggesting this, I have written the script, I just wanted to ask do you want Table of Content for README.md file?

[palisadoes]

Yes, let's keep it for consistency