Skip to content

Add a table of content with a link to snippets so it is easier to navigate the readme file. #6

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

Open
Tracked by #2
dev-shetty opened this issue May 16, 2023 · 8 comments
Assignees
Labels
beginner-friendly Even a beginner can contribute documentation Improvements or additions to documentation enhancement New feature or request good first issue Good for newcomers hacktoberfest

Comments

@dev-shetty
Copy link
Owner

No description provided.

@dev-shetty dev-shetty added documentation Improvements or additions to documentation enhancement New feature or request good first issue Good for newcomers beginner-friendly Even a beginner can contribute labels May 17, 2023
@vagxrth
Copy link

vagxrth commented Sep 27, 2023

Hey, @deveesh-shetty can you assign this issue to me? I'd love to contribute further to it.

@dev-shetty
Copy link
Owner Author

Oh yeah sure!

@vagxrth I assigned the issue to you...

@Salonikansal2
Copy link

can you assign it to me

@dev-shetty
Copy link
Owner Author

@Salonikansal2 this issue has already been assigned to @vagxrth, you can checkout other issues in the repo.

If you have any questions feel free to comment on those issues.

@vagxrth
Copy link

vagxrth commented Oct 6, 2023

Hey @deveesh-shetty I would like to ask you to help me with an issue over this. Can you please tell me like which is the main page of the project on which a table of contents has to be created, by table of contents what I'm comprehending is a navbar so If I'm not wrong please help me out with the query.

@dev-shetty
Copy link
Owner Author

dev-shetty commented Oct 7, 2023

@vagxrth sorry for the confusion, I meant the table of contents for the readme file... But now It seems there are some issues with the Readme file.

  1. The contributor has to add a Folder path which is redundant as we have a codepen link, and it is work to put in while creating a PR.
  2. The Image is also another thing, we should completely remove it because to add an Image to the GitHub cloud storage they have to drag and drop it to the Readme file in GitHub, which is again difficult while creating PR.

So I am thinking of adding a Frontend website for the repo where we can show all the projects, with preview and code links. I will push the template website soon.
And we have snippets.json as well which we can use to populate the website snippets.

So now what you can do is create a readme file with content like this on top of the current table we can remove the old one in later stages...

## Snippets
- [Name of the Snippet](Code Pen Link) - Author
- [Name of the Snippet](Code Pen Link) - Author
- [Name of the Snippet](Code Pen Link) - Author
<Continue this>

You can get these details from snippets.json and once cross check with the folders so that we didn't miss anything!

I hope this helps. If not, feel free to ask questions about it if I missed something

hamshini112 added a commit to hamshini112/CSS-Is-Fun that referenced this issue Oct 21, 2023
@Hamshinishetty
Copy link
Contributor

I would like to contribute on this. Can you assign this task to me?

@dev-shetty
Copy link
Owner Author

Last contributor doesn't seem active... Assigning it to you!

@dev-shetty dev-shetty assigned Hamshinishetty and unassigned vagxrth Oct 21, 2023
Hamshinishetty added a commit to Hamshinishetty/CSS-Is-Fun that referenced this issue Oct 21, 2023
dev-shetty pushed a commit that referenced this issue Oct 21, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
beginner-friendly Even a beginner can contribute documentation Improvements or additions to documentation enhancement New feature or request good first issue Good for newcomers hacktoberfest
Projects
None yet
Development

Successfully merging a pull request may close this issue.

4 participants