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

Needs a better, more in-depth README #55

Open
sreekaransrinath opened this issue Jul 7, 2020 · 10 comments
Open

Needs a better, more in-depth README #55

sreekaransrinath opened this issue Jul 7, 2020 · 10 comments
Assignees
Labels
beginners documentation Improvements or additions to documentation first-timers-only good first issue Good for newcomers help wanted Extra attention is needed

Comments

@sreekaransrinath
Copy link
Owner

No description provided.

@sreekaransrinath sreekaransrinath added documentation Improvements or additions to documentation help wanted Extra attention is needed good first issue Good for newcomers first-timers-only beginners labels Jul 7, 2020
@devaslooper
Copy link
Contributor

devaslooper commented Jul 24, 2020

@sreekaransrinath Can I contribute?

@sreekaransrinath
Copy link
Owner Author

Feel free @devaslooper , I'm assigning you to this task!

@logan-mo
Copy link
Contributor

logan-mo commented Aug 8, 2020

@sreekaransrinath
Can I contribute as well? I am a new developer, but I have some background in Content writing. I would definitely want to help out.

@logan-mo
Copy link
Contributor

logan-mo commented Aug 8, 2020

I've pushed a description with just rephrasing what was there already in the description. Give it a look.

@devaslooper
Copy link
Contributor

devaslooper commented Aug 15, 2020

@sreekaransrinath I have almost finished the readme. But have been experiencing issues with one of the hyperlinks in the table of contents. Please have a look #63 PR.
It is rendering correctly in my markdown editor but is broken when I pushed to the remote on github

@lee00286
Copy link

lee00286 commented Aug 15, 2020

@devaslooper Hello, I have been hovering through the GitHub and found your comment. I think the hyperlink is broken due to the colon(:). How about removing the colons in each bracket, like [Overview](#Overview)?

@devaslooper
Copy link
Contributor

devaslooper commented Aug 15, 2020

@lee00286 Thanks for your suggestion. I tried it out, but still no luck..
What is weird to me, is that this is happening only for the 3rd link and not the others 🤔

@lee00286
Copy link

lee00286 commented Aug 16, 2020

@devaslooper The hyperlink wouldn't work with blank space between the words. For example, [What is an Apple](#What-is-an-Apple) will work fine, while [What is an Apple](#What is an Apple) won't work. I would recommend referring some examples in https://github.com/ekalinin/github-markdown-toc.

@devaslooper
Copy link
Contributor

@lee00286 The spaces in between was causing the error, along with the fact that markdown doesn't like the text in the () to be in uppercase.
Thanks for your help and the resource! :)

@vardaan-raj
Copy link

Hello! I have experience in content writing and would like to contribute.
So can you tell me a bit about this and what is it that you specifically want

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
beginners documentation Improvements or additions to documentation first-timers-only good first issue Good for newcomers help wanted Extra attention is needed
Projects
None yet
Development

No branches or pull requests

5 participants