Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Updated Readme.md #135

Merged
merged 10 commits into from
Aug 3, 2023
Merged

Updated Readme.md #135

merged 10 commits into from
Aug 3, 2023

Conversation

neelimagoogly
Copy link
Contributor

@neelimagoogly neelimagoogly commented Jul 13, 2023

I have added the diagrams of General Workflow of fAIr and fAIr architecture to the README file wrt #128. @kshitijrajsharma , @omranlm and @petya-kangalova please review it.

@neelimagoogly neelimagoogly added documentation Improvements or additions to documentation Outreachy Project tasks for Outreachy internship - May to August 2023 labels Jul 13, 2023
@omranlm
Copy link
Contributor

omranlm commented Jul 13, 2023

I would recommend adding narrative explanations for the diagrams. They feel (my point of view) bare and the idea behind is not so clear .. However, @kshitijrajsharma and myself should do as we talked about it before. I would suggest you @neelimagoogly try to put a narrative description based on your understanding as a core text. Then I can edit with Kshitij and close the PR
Thank

@neelimagoogly neelimagoogly self-assigned this Jul 14, 2023
@neelimagoogly
Copy link
Contributor Author

I would recommend adding narrative explanations for the diagrams. They feel (my point of view) bare and the idea behind is not so clear .. However, @kshitijrajsharma and myself should do as we talked about it before. I would suggest you @neelimagoogly try to put a narrative description based on your understanding as a core text. Then I can edit with Kshitij and close the PR Thank

Done.

@kshitijrajsharma
Copy link
Member

@neelimagoogly
Few tips for Raising PR :

  • Provide a Meaningful Title & Summary description which narrates the changes you did on PR
  • Request review from Reviewers tab located on right side of the PR Screen
  • Convert PR to Draft when you are working on it

@neelimagoogly
Copy link
Contributor Author

@neelimagoogly Few tips for Raising PR :

  • Provide a Meaningful Title & Summary description which narrates the changes you did on PR
  • Request review from Reviewers tab located on right side of the PR Screen
  • Convert PR to Draft when you are working on it

Thanks @kshitijrajsharma , I will keep this in mind while creating PRs everytime.

Copy link
Member

@kshitijrajsharma kshitijrajsharma left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Better to use relative path like this (./docs) instead of full links
In this way user working on any branch can have access to this relatively
This needs to be changed where files are referenced in all over the PR except external links

This assets folder can be used to add pictures and videos  to use relative path like this (./assets) instead of full links and user working on any branch can have access to this relatively as suggested .
@kshitijrajsharma kshitijrajsharma merged commit 9598563 into master Aug 3, 2023
2 checks passed
@kshitijrajsharma kshitijrajsharma deleted the neelimagoogly-patch-4 branch August 3, 2023 09:22
jeafreezy pushed a commit to jeafreezy/fAIr that referenced this pull request Sep 18, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation Outreachy Project tasks for Outreachy internship - May to August 2023
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants