search

PalisadoesFoundation / talawa-docs

Documentation for Talawa and Talawa-API
https://docs.talawa.io/
GNU General Public License v3.0
44 stars 146 forks source link

Refactor:- Talawa homepage refactor #646

Closed Biki-das closed 1 year ago

Biki-das commented 1 year ago

What kind of change does this PR introduce?

refactor

Issue Number:

fixes partially #635

Did you add tests for your changes?

No

Snapshots/Videos:

If relevant, did you update the documentation?

Summary

@aviraldevv raised this issue of refactoring the code of the Talawa current documentation home landing, the whole of code was injected into one file and it need organization with tweaks here and there, to make it easy for future maintenance , code readability and easy to apply changes.

I have organized the file into layouts and then added them to the main index.ts file , also since the files were not regular react component ,they were typescript components, so i have also introduced type safety to few components wherever possible, there was a small change in one of the animation file , which is done to introduce better performance.

Does this PR introduce a breaking change?

No

Other information

I was instructed by @aviraldevv to push the PR of my changes, see comment #https://github.com/PalisadoesFoundation/talawa-docs/issues/635#issuecomment-1524049598

Have you read the contributing guide?

Yes

github-actions[bot] commented 1 year ago

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 and there are no merge conflicts.

The process helps maintain accurate and well-formatted documentation 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. :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.
Biki-das commented 1 year ago

cc @Cioppolo14 @aviraldevv , i have made the PR to have a better understanding of my changes, if you feel to close it, it's fine!

palisadoes commented 1 year ago

@anwersayeed @tasneemkoushar @evasharma12 @Kevoniat @Rumone Please review

aviraldevv commented 1 year ago

@Biki-das

Please share the screen-recording of running website with current changes.

Biki-das commented 1 year ago

@Biki-das

Please share the screen-recording of running website with current changes.

Sure!

aviraldevv commented 1 year ago

@Biki-das

I would like to suggest some more changes to the PR -

Also please fix the comment of your PR so that it doesn't automatically closes the parent issue.

Biki-das commented 1 year ago

@Biki-das

@aviraldevv Please share the screen-recording of running website with current changes.

https://user-images.githubusercontent.com/72331432/235347566-059d1dbd-3542-406f-9b11-29ca73d580ff.mp4

aviraldevv commented 1 year ago

Looks good, go ahead with the rest of the changes.

Biki-das commented 1 year ago

@aviraldevv pushed the changes as requested by you ,regarding the PR fix tag which issue should i link to you as you said it will either close the parent issue!

aviraldevv commented 1 year ago

@aviraldevv pushed the changes as requested by you ,regarding the PR fix tag which issue should i link to you as you said it will either close the parent issue!

Just make it -

Fixes

Issue Number

This will not automatically close the issue.

aviraldevv commented 1 year ago

@Biki-das

Is the website functional after changes??

Biki-das commented 1 year ago

@Biki-das

Is the website functional after changes??

Yep it's working fine also checked for responsiveness too and everything seem to work

aviraldevv commented 1 year ago

@aviraldevv pushed the changes as requested by you ,regarding the PR fix tag which issue should i link to you as you said it will either close the parent issue!

Just make it -

Fixes #Issue Number

This will not automatically close the issue.

@Biki-das

Please do this before it gets merged.

Cioppolo14 commented 1 year ago

@Biki-das Please fix the first comment...maybe we can mention the issue without closing it, so that it is trackable in the future? Am I understanding it correctly that we don't want to close https://github.com/PalisadoesFoundation/talawa-docs/issues/635 because @aviraldevv is still working on it? This just supports that effort in part?

Biki-das commented 1 year ago

@Biki-das Please fix the first comment...maybe we can mention the issue without closing it, so that it is trackable in the future? Am I understanding it correctly that we don't want to close #635 because @aviraldevv is still working on it? This just supports that effort in part?

yes! @aviraldevv told to keep it fix#issuenumber, @Cioppolo14 done, i have just made a mention type making the f smallercase, this won't close the issue now!

aviraldevv commented 1 year ago

@Cioppolo14

We can merge this now.