Documentation Automation: Bridging talawa-api and talawa-docs repositories

[gautam-divyanshu]

What kind of change does this PR introduce?

Issue Number:

Fixes #1897

Did you add tests for your changes?

Snapshots/Videos:

1. Push workflow runs when a PR is merged to develop branch
2. when PR is merged to develop then it creates a empty commit to automated-docs branch
3. then after empty commit copy-docs-to-talawa-docs workflow runs

it's working locally on my forked repo.

If relevant, did you update the documentation?

Summary

Does this PR introduce a breaking change?

Other information

Have you read the contributing guide?

Summary by CodeRabbit

• Chores
  • Updated GitHub workflow to trigger on develop branch instead of all branches.
  • Refined Typedoc generation command for better documentation output.
  • Added a new step to automate copying documentation to another repository.

[coderabbitai[bot]]

Walkthrough

The changes streamline the documentation process by triggering actions only on the develop branch, refining the TypeDoc generation command, and introducing steps to automate copying generated documentation to another repository, ensuring synchronization between talawa-api and talawa-docs.

Changes

File	Change Summary
.github/workflows/push.yml	Adjusted branch trigger to develop, updated TypeDoc command, added step to copy documentation externally

Sequence Diagrams

sequenceDiagram
    participant Developer
    participant GitHubActions
    participant talawa-api
    participant talawa-docs

    Developer->>GitHubActions: Push to develop branch
    GitHubActions->>talawa-api: Generate Typedoc
    GitHubActions->>talawa-docs: Copy documentation files

Assessment against linked issues

Objective	Addressed	Explanation
Automate the documentation generation and syncing between talawa-api and talawa-docs (#1897)	✅
Ensure commits to develop trigger documentation generation (#1897)	✅
Refine Typedoc command for cleaner documentation output (#1897)	✅

Poem

In the land of code where branches intertwine,
Docs now flow like a well-aged wine. 🍷
Develop shines with a touch so grand,
And typedoc dances at GitHub's hand.
From talawa-api's clever lines,
To talawa-docs, our knowledge binds. 📜

---

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](https://twitter.com/intent/tweet?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A&url=https%3A//coderabbit.ai) - [Mastodon](https://mastodon.social/share?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A%20https%3A%2F%2Fcoderabbit.ai) - [Reddit](https://www.reddit.com/submit?title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&text=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code.%20Check%20it%20out%3A%20https%3A//coderabbit.ai) - [LinkedIn](https://www.linkedin.com/sharing/share-offsite/?url=https%3A%2F%2Fcoderabbit.ai&mini=true&title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&summary=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code)

Tips

### Chat There are 3 ways to chat with [CodeRabbit](https://coderabbit.ai): - Review comments: Directly reply to a review comment made by CodeRabbit. Example: - `I pushed a fix in commit .` - `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 generate interesting stats about this repository and render them as a table.` - `@coderabbitai show all the console.log statements in this repository.` - `@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 as 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 resolve` resolve all the CodeRabbit review comments. - `@coderabbitai configuration` to show the current CodeRabbit configuration for the repository. - `@coderabbitai help` to get help. Additionally, you can add `@coderabbitai ignore` anywhere in the PR description to prevent this PR from being reviewed. ### CodeRabbit Configration File (`.coderabbit.yaml`) - You can programmatically configure CodeRabbit by adding a `.coderabbit.yaml` file to the root of your repository. - Please see the [configuration documentation](https://docs.coderabbit.ai/guides/configure-coderabbit) for more information. - If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: `# yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json` ### Documentation and Community - Visit our [Documentation](https://coderabbit.ai/docs) for detailed information on how to use CodeRabbit. - Join our [Discord Community](https://discord.com/invite/GsXnASn26c) to get help, request features, and share feedback. - Follow us on [X/Twitter](https://twitter.com/coderabbitai) for updates and announcements.

[github-actions[bot]]

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

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. :dart: 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[bot]]

Codecov Report

All modified and coverable lines are covered by tests :white_check_mark:

Project coverage is 98.50%. Comparing base (c0468a4) to head (e5e8e87). Report is 581 commits behind head on develop.

Additional details and impacted files

```diff @@ Coverage Diff @@ ## develop #2344 +/- ## =========================================== + Coverage 98.17% 98.50% +0.32% =========================================== Files 184 348 +164 Lines 10767 25185 +14418 Branches 835 2349 +1514 =========================================== + Hits 10571 24809 +14238 - Misses 186 373 +187 + Partials 10 3 -7 ```

:umbrella: View full report in Codecov by Sentry.
:loudspeaker: Have feedback on the report? Share it here.

[tasneemkoushar]

@gautam-divyanshu LGTM, approving your PR. Feel free to merge. I hope you have tested it in your local.

[tasneemkoushar]

@anwersayeed can you please review & approve the PR

[gautam-divyanshu]

@tasneemkoushar Yes I have tested it locally

[anwersayeed]

Closing this PR because the mechanism to update the documentation into talawa-docs has now changed. Please refer to https://github.com/PalisadoesFoundation/talawa-docs/commit/de85194509acb2f74a8ca3f24d48a95d3bc9e056. Thanks.