Free-Software-Books icon indicating copy to clipboard operation
Free-Software-Books copied to clipboard

A better way to add describtion to each book for newbies

Open sammy-code98 opened this issue 2 years ago • 14 comments

I think i found a better way to add description to the books added to this project

In the main markdown file, a table can be written with author, description and other relevant fields/columns

For reference i will attach an image and also a link to a repo where similar stuff was done.

Hope this helps. Screenshot Capture - 2023-02-09 - 13-41-10

https://github.com/hackerkid/Mind-Expanding-Books

sammy-code98 avatar Feb 09 '23 12:02 sammy-code98

This is an awesome idea ✨ You mean the readMe file right? @binadiegha what do you think?

EOEboh avatar Feb 09 '23 19:02 EOEboh

Also what is the source for the ratings? @sammy-code98

EOEboh avatar Feb 09 '23 19:02 EOEboh

LGTM, The book titles are going to be the links yea? and also, yea, what's gonna be the source of the ratings?

binadiegha avatar Feb 09 '23 20:02 binadiegha

This is an awesome idea sparkles You mean the readMe file right? @binadiegha what do you think?

yeah i mean the readme file

sammy-code98 avatar Feb 09 '23 21:02 sammy-code98

Also what is the source for the ratings? @sammy-code98

For this particular one i shared, the ratings are from GoodReads

https://www.goodreads.com/

but we can still replace the ratings for the short description which someone suggested earlier.

sammy-code98 avatar Feb 09 '23 21:02 sammy-code98

This format is great, but I don't really think we need the ratings.

Why: Because some contributors may not know or have the link to the main website where the book is published. And also because some contributors may only have the books in their google drive or other cloud storage bucket.

ibrahimraimi avatar Feb 11 '23 10:02 ibrahimraimi

This format is great, but I don't really think we need the ratings.

Why: Because some contributors may not know or have the link to the main website where the book is published. And also because someone contributors may only have the books in their google drive or other cloud storage bucket.

yeah , rightly said Ibrahim,

that's why is suggest we replace the ratings with the short description

sammy-code98 avatar Feb 11 '23 15:02 sammy-code98

Hello guys, what's our resolve on this issue?

binadiegha avatar Feb 14 '23 13:02 binadiegha

Let us go with this format, it's great.

ibrahimraimi avatar Feb 14 '23 14:02 ibrahimraimi

This format is great. But if we're thinking of having a lengthier description, we can abstract all descriptions to a separate file and just add the link to that line in one of the columns.

For this to work though, we'll have to tag every resource with that hashtag (I think it works as a link tag, apart from emboldening text, but I stand to be corrected though) so it can be located with just one click.

BaRzz007 avatar Feb 14 '23 15:02 BaRzz007

This format is great. But if we're thinking of having a lengthier description, we can abstract all descriptions to a separate file and just add the link to that line in one of the columns.

For this to work though, we'll have to tag every resource with that hashtag (I think it works as a link tag, apart from emboldening text, but I stand to be corrected though) so it can be located with just one click.

I don't think there is a need for this. We could be add instructions to limit the description to n- characters

binadiegha avatar Feb 14 '23 17:02 binadiegha

Capt @EOEboh what are your thoughts on this.

everyone has shared what they think is best and are all good reasons.

sammy-code98 avatar Feb 15 '23 16:02 sammy-code98

@sammy-code98 I'd appreciate if we can start working on this now. On my part, I'm trying to refactor some of the documentation and guidelines.

Also a code of conduct

EOEboh avatar Feb 22 '23 21:02 EOEboh

okay capt @EOEboh

what informations are we looking to catch from the books/materials ie , names, author ,........

sammy-code98 avatar Feb 24 '23 21:02 sammy-code98