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: Portfolio initialised with header and footer #2

Open
wants to merge 3 commits into
base: main
Choose a base branch
from

Conversation

Aniket762
Copy link

@Aniket762 Aniket762 commented Oct 3, 2021

Hey there, I have initialized the readme with a header with CircuitVerse banner, tagline, and description while the footer contains various social media icons. Before moving forward I wanted to know your opinion!

I was curious on what are the other components which I should add, things I have in my mind:

  1. One liner about all the repositories present with hyperlinks
  2. A generalized guide on how to contribute
  3. Some programs CircuitVerse have been part of (for example GSoC)
  4. A small 3-4 liner story on how it started from IIITB
  5. Not sure if it will be good but some testimonials

These are the things I was thinking of adding, before I move forward I wanted to clarify if my thought process goes along the community.

Another doubt, should I include emojis in the readme? 🙈

fixes #1

@tachyons tachyons requested a review from nitin10s October 4, 2021 03:31
@nitin10s
Copy link
Member

nitin10s commented Oct 4, 2021

Can you also attach screenshots? Thanks

@nitin10s
Copy link
Member

nitin10s commented Oct 4, 2021

Also, regarding the different components, there should be a reason to put them, what do you propose is the overall purpose of this readme?

@Aniket762
Copy link
Author

Also, regarding the different components, there should be a reason to put them, what do you propose is the overall purpose of this readme?

The readme should showcase and give a brief idea to new contributors or visitors about what CircuitVerse is all about, the projects which they are currently focusing on. The ways new contributors can contribute apart from Github contributions as in Blogs or tutorials dedicated to CircuitVerse. Ultimately a one-pager portfolio so that after going through it people can understand the community culture, project, and most importantly what CircuitVerse is all about.

This is my opinion would like to know what the core team wants me to include. We can even keep it simple with just the header and footer as I have made as of now.

@Aniket762
Copy link
Author

Can you also attach screenshots? Thanks

Screenshot 2021-10-05 at 3 59 18 PM

Copy link
Member

@ayan-biswas0412 ayan-biswas0412 left a comment

Choose a reason for hiding this comment

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

  1. Please see the changes
  2. Change all the types of https://github.com/Aniket762/.github/blob/main/assets/youtube.svg links from the Readme and link them with local references with this repo

Good work @Aniket762 🎉


<p align="center">Get in touch</p>
<p align="center">
<a href="mailto:"><img alt="email_logo"
Copy link
Member

Choose a reason for hiding this comment

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

Suggested change
<a href="mailto:"><img alt="email_logo"
<a href="mailto: [email protected]"><img alt="email_logo"

<p align="center">Get in touch</p>
<p align="center">
<a href="mailto:"><img alt="email_logo"
src="https://github.com/Aniket762/.github/blob/main/assets/email.svg"></a>
Copy link
Member

Choose a reason for hiding this comment

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

please change this and other file src's below, from your own account to relative local paths of svgs of this repository

<a href=""><img alt="slack_logo"
src="https://github.com/Aniket762/.github/blob/main/assets/slack.svg"></a>
&nbsp;
<a href="https://twitter.com/layer5"><img alt="twitter_logo"
Copy link
Member

Choose a reason for hiding this comment

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

Suggested change
<a href="https://twitter.com/layer5"><img alt="twitter_logo"
<a href="https://twitter.com/CircuitVerse"><img alt="twitter_logo"

<a href=""><img alt="github_logo"
src="https://github.com/Aniket762/.github/blob/main/assets/github.svg"></a>
&nbsp;
<a href=""><img alt="linkedIn_logo"
Copy link
Member

Choose a reason for hiding this comment

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

Suggested change
<a href=""><img alt="linkedIn_logo"
<a href="https://www.linkedin.com/company/circuitverse"><img alt="linkedIn_logo"

<a href="https://twitter.com/layer5"><img alt="twitter_logo"
src="https://github.com/Aniket762/.github/blob/main/assets/twitter.svg"></a>
&nbsp;
<a href=""><img alt="github_logo"
Copy link
Member

Choose a reason for hiding this comment

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

Suggested change
<a href=""><img alt="github_logo"

Copy link
Member

Choose a reason for hiding this comment

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

remove the Github logo as it will be shown in the GitHub itself

src="https://github.com/Aniket762/.github/blob/main/assets/twitter.svg"></a>
&nbsp;
<a href=""><img alt="github_logo"
src="https://github.com/Aniket762/.github/blob/main/assets/github.svg"></a>
Copy link
Member

Choose a reason for hiding this comment

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

Suggested change
src="https://github.com/Aniket762/.github/blob/main/assets/github.svg"></a>

&nbsp;
<a href=""><img alt="github_logo"
src="https://github.com/Aniket762/.github/blob/main/assets/github.svg"></a>
&nbsp;
Copy link
Member

Choose a reason for hiding this comment

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

Suggested change
&nbsp;

<a href=""><img alt="linkedIn_logo"
src="https://github.com/Aniket762/.github/blob/main/assets/linkedIn.svg"></a>
&nbsp;
<a href=""><img alt="youtube_logo"
Copy link
Member

Choose a reason for hiding this comment

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

Suggested change
<a href=""><img alt="youtube_logo"
<a href="https://www.youtube.com/channel/UCAK48dCPc_QON6Y5QqqRLOg"><img alt="youtube_logo"

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Enhancing the portfolio | Growing the community
3 participants