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] Enhance our Documentation #251

Open
vish-rt opened this issue Oct 1, 2023 · 5 comments
Open

[DOCS] Enhance our Documentation #251

vish-rt opened this issue Oct 1, 2023 · 5 comments
Labels
documentation Improvements or additions to documentation enhancement New feature or request good first issue Good for newcomers hacktoberfest Label for highlighting Hacktoberfest Issue

Comments

@vish-rt
Copy link
Contributor

vish-rt commented Oct 1, 2023

Hacktoberfest, while being the biggest celebration of Open Source projects where talented developers try to contribute to others' projects, believes in Low or No Code Contributions.
These contributions are the backbone of any Open Source project and we strive to believe in contributors who can think outside the box and contribute beyond the code.

TCET Open Source houses 50+ repositories of various projects. While some of them are incubated and may not be documented, the ones made by our Teams are documented at our official website.

If you feel that some parts of our documentation can be improved and wish to work on it, feel free to comment on this issue and a maintainer will reach you back.

@vish-rt vish-rt added documentation Improvements or additions to documentation enhancement New feature or request good first issue Good for newcomers hacktoberfest Label for highlighting Hacktoberfest Issue labels Oct 1, 2023
@Rajdeep1311
Copy link
Contributor

I would like to add a banner of the website on the documentation

@demonkillerr
Copy link
Member

I would like to add a banner of the website on the documentation

can you please explain in depth, how would you do it?

@peichincc
Copy link
Contributor

peichincc commented Oct 6, 2023

I would love to add several contents to the current README.md, for instance:

Text (short!) and Visual info for the most recent repos, could be screenshots or demo GIFs (show the user flow) of each project
Screenshot 2023-10-06 at 11 09 51 AM

Just under each repo to show the main message to the firstcomer about how each project could be about:
For instance the screenshot
Screenshot 2023-10-06 at 11 12 50 AM
Or the demo GIF
ezgif-1-45bb0cd7a6

Let me know how this sounds to you! :D

Screenshot 2023-10-07 at 8 25 35 AM

ezgif-1-5049f225d1
<img width="1457" alt="Screenshot 2023-10-07 at 8 36 18 AM" src="https://github.com/tcet-opensource/documentation/ass
Screenshot 2023-10-07 at 8 37 57 AM
ets/104899687/3ff0ddc0-31cf-41cf-aee1-d4620582cd58">
Screenshot 2023-10-07 at 8 36 18 AM
Screenshot 2023-10-07 at 8 40 04 AM

@demonkillerr
Copy link
Member

Very good idea to implement here: https://opensource.tcetmumbai.in/docs/about-tcetopensource/

@peichincc
Copy link
Contributor

Very good idea to implement here: https://opensource.tcetmumbai.in/docs/about-tcetopensource/

Cool then I will try working on it! Thank you @demonkillerr

@himanshu-03 himanshu-03 pinned this issue Oct 11, 2023
@himanshu-03 himanshu-03 added this to the TCET Open Source Website milestone Oct 11, 2023
@himanshu-03 himanshu-03 moved this to Todo in Docs Team Oct 11, 2023
@AadilRayeen AadilRayeen unpinned this issue Oct 14, 2023
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 enhancement New feature or request good first issue Good for newcomers hacktoberfest Label for highlighting Hacktoberfest Issue
Projects
Status: Todo
Development

No branches or pull requests

5 participants