Syknapse/Contribute-To-This-Project

Update card creation step (step 5) in main README tutorial

codeHokage1 opened this issue · 3 comments

codeHokage1 commented

The tutorial step for creating and copying card in the main README seems quite different from the actual step to be taken in index.html .

While the tutorial mentioned to find the template in the header section, just around the head tag, the actual index.html file doesn't even have a header section.

  1. This shows the instruction in the README
Syk-Contribute-Tutorial
  1. And this shows the actual index.html file
Syk-Contribute-Readme

While this tutorial is absolutely amazing, this particular step may seem confusing for some first-contributors; especially some who are not very familiar with the syntax that is present in the actual file.

I will be very glad to help update this. Currently working on it and will send a PR soon!

ascodeasice commented

Hi, thanks for the issue, the file indeed doesn't have a header tag.
I think you can

  1. remove text about header
  2. add more description to help user find the template (by line number/ find certain tag..., anything you think appropriate)

Also, the head tag is also pretty far from the template, maybe we can also update that part

@codeHokage1 , I've assigned this issue to you

codeHokage1 commented

@ascodeasice Alright! I am right on it.

codeHokage1 commented

Hello @ascodeasice
I just submitted a PR with these fixes: #3411. I hope it's more contextual and understandable.