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

updated the documentation with a new figma file #718

Closed aashimawadhwa closed 9 months ago

aashimawadhwa commented 9 months ago

What kind of change does this PR introduce? updated the documentation with the new figma file

Issue Number:

Fixes #695

Did you add tests for your changes? not required

github-actions[bot] commented 9 months 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.
aashimawadhwa commented 9 months ago

@palisadoes @noman2002 @tasneemkoushar please look into it and merge it.

palisadoes commented 9 months ago

@aashimawadhwa merge with the latest upstream. I think that will fix the errors

aashimawadhwa commented 9 months ago

@aashimawadhwa merge with the latest upstream. I think that will fix the errors

I am already up to date.

palisadoes commented 9 months ago

It's because of our upgrade to Docusaurus v3 and our Admin documentation workflow doesn't support the new markdown standard

  1. Run this command in the root directory
    1. npx docusaurus-mdx-checker
  2. Then add a \ character in front of every <, >, } and } to every reported file. It's about 30 files. I'll send you a spreadsheet to make it faster
  3. We have an issue to fix this.
    1. https://github.com/PalisadoesFoundation/talawa-admin/issues/1279