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

[DOCS] Update about-tcetopensource.mdx #270

Merged
merged 37 commits into from
Oct 13, 2023

Conversation

peichincc
Copy link
Contributor

@peichincc peichincc commented Oct 7, 2023

Add projects img to documentation

Title :

Update about-tcetopensource.mdx

Preview

Screenshot 2023-10-10 at 09 25 33
Screenshot 2023-10-11 at 8 35 40 AM

Issue no :

[DOCS] Enhance our Documentation #251

Description

Add a project image to each project to enhance the current document, user could easily understand what it looks like before opening the project website.

Checklist

  • I have read and agree to abide by the Code of Conduct
  • I have read and followed the Contributing Guidelines

Fix

  • replace the TCET Linux image
Screenshot 2023-10-07 at 8 39 06 AM
  • add space
  • add Documentation Site image
Screenshot 2023-10-11 at 16 02 36
  • rename Documentation Website to TCET Open Source Website

add projects img to documentation
@vercel
Copy link

vercel bot commented Oct 7, 2023

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

Name Status Preview Comments Updated (UTC)
documentation ✅ Ready (Inspect) Visit Preview 💬 Add feedback Oct 12, 2023 11:47am

Copy link
Contributor

@vish-rt vish-rt left a comment

Choose a reason for hiding this comment

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

Deployment is failing due to the following errors in the img tag. Have a look at it.

image

@vish-rt
Copy link
Contributor

vish-rt commented Oct 7, 2023

Recommend you to fetch updates from main before making any updates.

@peichincc
Copy link
Contributor Author

Deployment is failing due to the following errors in the img tag. Have a look at it.

image

Fixed the jsx cloing issue!

@peichincc
Copy link
Contributor Author

@vish-rt the branch is already updated and fixed the deploy error, please have a look! Thank you!

Copy link
Member

@himanshu-03 himanshu-03 left a comment

Choose a reason for hiding this comment

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

image

There is alignment issues in Ongoing Projects images

@himanshu-03
Copy link
Member

himanshu-03 commented Oct 11, 2023

It would be great to have some spaces and also the documentation website image is missing

@himanshu-03 OK, maybe one more line between the image and the bold text, should be fine.

And also, which one is exactly the documentation website? because I could not find it in https://github.com/tcet-opensource/.github/blob/main/profile/README.md If the website link is provided, I could add the extra image.

And would like to confirm if is there anything to change for this Update?

Okay so basically there's a little change you can change the name of Documentation Website to TCET Open Source Website because we have our documentation on our website itself.

For the screenshot, you can take a SS of this page and upload this image. TCET Open Source Website

Also, the spacings which you gave didnt solved the issue. Try keeping <br /> in a seperate line and leave a line after the command, I think it will work then

image

@peichincc
Copy link
Contributor Author

peichincc commented Oct 11, 2023

It would be great to have some spaces and also the documentation website image is missing

@himanshu-03 OK, maybe one more line between the image and the bold text, should be fine.
And also, which one is exactly the documentation website? because I could not find it in https://github.com/tcet-opensource/.github/blob/main/profile/README.md If the website link is provided, I could add the extra image.
And would like to confirm if is there anything to change for this Update?

Okay so basically there's a little change you can change the name of Documentation Website to TCET Open Source Website because we have our documentation on our website itself.

For the screenshot, you can take a SS of this page and upload this image. TCET Open Source Website

Also, the spacings which you gave didnt solved the issue. Try keeping <br /> in a seperate line and leave a line after the command, I think it will work then

image

@himanshu-03
I added one more <br/>, now it looks a bit far, maybe you could check the preview to see (just one <br/> added now)

And for the documentation website image and rename, are all done.

In the commits so far:

  • Add space
  • Add image to documentation website
  • Rename documentation website

@peichincc
Copy link
Contributor Author

@himanshu-03 @vish-rt could you please check whether this is ok for now? Thank you :)

Copy link
Member

@himanshu-03 himanshu-03 left a comment

Choose a reason for hiding this comment

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

Can you remove the extra <br/> tags beside the Project name. IDTS they are required

@peichincc
Copy link
Contributor Author

Can you remove the extra <br/> tags beside the Project name. IDTS they are required

@himanshu-03 done! Please check, thank you!

Copy link
Member

@himanshu-03 himanshu-03 left a comment

Choose a reason for hiding this comment

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

LGTM!

@himanshu-03 himanshu-03 changed the base branch from main to staging October 12, 2023 14:30
@peichincc
Copy link
Contributor Author

Can @vish-rt check if is it all good now? Thank you!

Copy link
Contributor

@vish-rt vish-rt left a comment

Choose a reason for hiding this comment

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

Will be shipped to production soon!

@vish-rt
Copy link
Contributor

vish-rt commented Oct 13, 2023

@peichincc thank you for contributing to this repository! We are merging your pull request 🚀

@vish-rt vish-rt added the hacktoberfest-accepted The pull request is overall hacktoberfest acceptable label Oct 13, 2023
@vish-rt vish-rt merged commit 84bec9a into tcet-opensource:staging Oct 13, 2023
3 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
hacktoberfest-accepted The pull request is overall hacktoberfest acceptable
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants