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

📝[Documentation Update]: Modification of Readme.md file #411

Merged
merged 17 commits into from
Jun 3, 2024
Merged

📝[Documentation Update]: Modification of Readme.md file #411

merged 17 commits into from
Jun 3, 2024

Conversation

Anjaliavv51
Copy link
Contributor

@Anjaliavv51 Anjaliavv51 commented Jun 2, 2024

Related Issues

[Cite any related issue(s) this pull request addresses. If none, simply state “None”]

Type of PR

  • Bug fix
  • Feature enhancement
  • Documentation update
  • Other (specify): _______________

Screenshots / videos (if applicable)

Screenshot_20240602_202649_GitHub.jpg

Screenshot_20240602_202652_GitHub.jpg

Screenshot_20240602_202655_GitHub.jpg

Screenshot_20240602_202659_GitHub.jpg

Checklist

  • I have gone through the contributing guide
  • I have updated my branch and synced it with project main branch before making this PR
  • I have performed a self-review of my code
  • I have tested the changes thoroughly before submitting this pull request.
  • I have provided relevant issue numbers, screenshots, and videos after making the changes.
  • I have commented my code, particularly in hard-to-understand areas.

Copy link

vercel bot commented Jun 2, 2024

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Comments Updated (UTC)
rapidoc ✅ Ready (Inspect) Visit Preview 💬 Add feedback Jun 3, 2024 7:54pm

Copy link
Contributor

@github-actions github-actions bot left a comment

Choose a reason for hiding this comment

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

Great job, @Anjaliavv51! 🎉 Thank you for submitting your pull request. Your contribution is valuable and we appreciate your efforts to improve our project.We will promptly review your changes and offer feedback. Keep up the excellent work! Kindly remember to check our contributing guidelines

@Anjaliavv51
Copy link
Contributor Author

@varshith257 please review the Changes.

@varshith257
Copy link
Collaborator

@Anjaliavv51 This is good but README (Markdown files) doesn't;t embed custom styles. See this:

<style> :root{ --ff-philosopher: "Philosopher", sans-serif; --ff-poppins: "Poppins", sans-serif; } </style>

This part of the code mayn't compile and appear as code in README

@Anjaliavv51
Copy link
Contributor Author

@varshith257 should i remove it?

@varshith257
Copy link
Collaborator

Better embed the font styles in separate section i.e.NOTE section header and put the code of <style></style> naming as used fonts

@varshith257
Copy link
Collaborator

@varshith257 should i remove it?

Then how the font can be used here as described in issue

@Anjaliavv51
Copy link
Contributor Author

Anjaliavv51 commented Jun 2, 2024

@varshith257 should i remove it?

Then how the font can be used here as described in issue

Can i write the Readme.md file code in HTML form

@Anjaliavv51
Copy link
Contributor Author

@varshith257 should i remove it?

Then how the font can be used here as described in issue

Can i write the Readme.md file code in HTML form

?

@varshith257
Copy link
Collaborator

varshith257 commented Jun 2, 2024

I think Readme files could be better in the Markdown files :)

@Anjaliavv51
Copy link
Contributor Author

Anjaliavv51 commented Jun 2, 2024

I think Readme files could be better in the Markdown files :)

I will solve this

@varshith257
Copy link
Collaborator

varshith257 commented Jun 2, 2024 via email

@Anjaliavv51
Copy link
Contributor Author

Anjaliavv51 commented Jun 2, 2024

Related Issues

issue #404

Type of PR

  • Bug fix
  • Feature enhancement
  • Documentation update
  • Other (specify): _______________

Screenshots / videos (if applicable)

Screenshot_20240602_202649_GitHub.jpg

Screenshot_20240602_202652_GitHub.jpg

Screenshot_20240602_202655_GitHub.jpg

Screenshot_20240602_202659_GitHub.jpg

Checklist

  • I have gone through the contributing guide
  • I have updated my branch and synced it with project main branch before making this PR
  • I have performed a self-review of my code
  • I have tested the changes thoroughly before submitting this pull request.
  • I have provided relevant issue numbers, screenshots, and videos after making the changes.
  • I have commented my code, particularly in hard-to-understand areas.

It is edited @varshith257

@varshith257
Copy link
Collaborator

Add this screenshots in the PR which had removed:
Screenshot (127)

this one too

Screenshot (128)

for reference, see the current readme and add back the images there in the current README.md

@Anjaliavv51
Copy link
Contributor Author

Add this screenshots in the PR which had removed:
Screenshot (127)

this one too

Screenshot (128)

for reference, see the current readme and add back the images there in the current README.md

Okay

@Anjaliavv51
Copy link
Contributor Author

@varshith257 please review the PR ,changes are made

@varshith257
Copy link
Collaborator

One screenshot isn't loaded check it once in view file

@Anjaliavv51
Copy link
Contributor Author

@varshith257 now u can check i made changes in that.

@Anjaliavv51
Copy link
Contributor Author

@varshith257 review the PR

@Anjaliavv51
Copy link
Contributor Author

@varshith257 what happened?

@varshith257
Copy link
Collaborator

Make the last line into center

@varshith257
Copy link
Collaborator

This one:

If you find this project helpful, please consider giving it a star!

@Anjaliavv51
Copy link
Contributor Author

Anjaliavv51 commented Jun 3, 2024

@varshith257 Now is it okay?

@Anjaliavv51
Copy link
Contributor Author

@varshith257 i changed it please check


</div>
<h3 style="text-align:center;font-size:2rem;">
If you find this project helpful, please consider giving it a star! <img src="https://raw.githubusercontent.com/Tarikul-Islam-Anik/tarikul-islam-anik/main/assets/images/Star.png" width="30" height="30"></p>
Copy link
Collaborator

Choose a reason for hiding this comment

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

Suggested change
If you find this project helpful, please consider giving it a star! <img src="https://raw.githubusercontent.com/Tarikul-Islam-Anik/tarikul-islam-anik/main/assets/images/Star.png" width="30" height="30"></p>
If you find this project helpful, please consider giving it a star! <img src="https://raw.githubusercontent.com/Tarikul-Islam-Anik/tarikul-islam-anik/main/assets/images/Star.png" width="30" height="30"></p>

Can you make this line to align in center?

@varshith257 varshith257 merged commit 1d49a05 into Anishkagupta04:main Jun 3, 2024
3 checks passed
@Anjaliavv51
Copy link
Contributor Author

@varshith257 is it okay now?

Copy link
Contributor

github-actions bot commented Jun 3, 2024

🎉 Your pull request has been successfully merged! 🎉 Thank you for your contribution to our project. Your efforts are greatly appreciated. Keep up the fantastic work! 🚀

@varshith257
Copy link
Collaborator

@Anjaliavv51 Thanks

@Anjaliavv51
Copy link
Contributor Author

@varshith257 added the labels?

@varshith257 varshith257 added gssoc level2 medium (enhancements) labels Jun 4, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
gssoc level2 medium (enhancements)
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants