doc: intent to restructure README.md to be more advertising and introducing to docs #6920

eljefedelrodeodeljefe · 2016-05-21T20:07:45Z

Our README.md currently is quite technical - in terms of being useful for collaboration and security-wise(?).

I am convinced efforts moving towards the READE being more advertising and attractive to the reader is worthwhile.

Good examples that come to mind:

https://github.com/kubernetes/kubernetes
https://github.com/docker/docker
https://github.com/libuv/libuv for the upper part

This would mean moving GPG stuff, maybe also the collaborator list, adding a logo etc.

claudiorodriguez · 2016-05-21T20:28:13Z

+1, at the very least I suggest having an easily recognizable link to our docs in the readme's first fold

eljefedelrodeodeljefe · 2016-05-24T14:01:19Z

For starters I could imagine something like:

README.md

Node.js

Lorem ipsum dolor sit amet, consectetur adipisicing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum.

eljefedelrodeodeljefe · 2016-05-24T14:03:01Z

cc @nodejs/documentation @nodejs/website

preco21 · 2016-05-24T14:51:04Z

What about big simbol on top of README.md?

As like: https://github.com/avajs/ava

ghost · 2016-05-24T14:55:05Z

@preco21 yeah, that sounds like what @eljefedelrodeodeljefe suggested

eljefedelrodeodeljefe · 2016-05-24T17:03:48Z

@preco21 I guess you mean before the h1-tag. This is the above. "README.md" just indicated what file we are in.

silverwind · 2016-05-24T18:36:24Z

~~Where would those LTS and Docs buttons lead to?~~ nevermind

By the way, If you're going with a logo, I'd say the h1 is redundant.

ghost · 2016-05-24T18:58:16Z

@silverwind does markdown do alt attributes? i'm worried about accessibility

silverwind · 2016-05-24T19:35:35Z

@tentakel yes, it does:

[![hi](http://res.cloudinary.com/jefe-io/image/upload/v1464098345/NodeJS_New_Pantone_owaqpk.png)](https://nodejs.org)

GitHub also supports a (very limited) set of HTML, but depending on where it's rendered, it might not get parsed correctly because HTML is a feature of Github-flavored markdown, e.g. non-standard.

<a href="https://nodejs.org">
  <img alt="hi" src="http://res.cloudinary.com/jefe-io/image/upload/v1464098345/NodeJS_New_Pantone_owaqpk.png"></img>
</a>

silverwind · 2016-05-24T19:38:47Z

Oh, and if we go with a logo, I'd really like to see a SVG (does a vector source file it exist?).

eljefedelrodeodeljefe · 2016-05-24T21:42:38Z

@silverwind semantically I agree, I think though that the h1-tag gets to be honored in SEO really well (all structure tags tho.)

ACK svg

eljefedelrodeodeljefe · 2016-05-24T21:43:27Z

Is there anyone with good design skills? maybe @mikeal for hooking up design people.

preco21 · 2016-05-24T23:27:37Z

@eljefedelrodeodeljefe I mean, h1-tag as graphical logo with link.

claudiorodriguez · 2016-05-25T08:00:29Z

There's this: https://commons.wikimedia.org/wiki/File:Node.js_logo.svg but the colors look a bit off

kravelin · 2017-03-18T13:48:47Z

Here's an SVG version of the logo, note I had to put it in a zip file as gitHub doesn't support uploading SVG files in the comments. I also tested using an svg image in a readme.md file and it didn't display on github, giving only the missing image icon so the svg may not be useful in this case and we'd have to use the png format.
logo-svg.zip

lpinca · 2017-03-18T13:59:47Z

An SVG version of the logo is also available here https://nodejs.org/static/images/logo.svg thanks to @silverwind (nodejs/nodejs.org#884).

silverwind · 2017-03-18T14:15:50Z

SVG works in READMEs, the light version should be more suitable in this case. I guess I can start on a PR. Do we want a horizontally centered logo, btw?

(I don't see @kravelin's version suitable, it's just a bitmap embedded in a SVG while mine is a proper scalable image)

silverwind · 2017-03-31T17:14:00Z

Logo PR here: #12148

Adds a centered logo to the README to make it a little more festive. As centering is not possible in pure Markdown, a bit of HTML is used. PR-URL: #12148 Ref: #6920 Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Anna Henningsen <anna@addaleax.net> Reviewed-By: Luigi Pinca <luigipinca@gmail.com> Reviewed-By: Colin Ihrig <cjihrig@gmail.com> Reviewed-By: Yuta Hiroto <hello@about-hiroppy.com> Reviewed-By: Richard Lau <riclau@uk.ibm.com> Reviewed-By: Italo A. Casas <me@italoacasas.com> Reviewed-By: Gibson Fahnestock <gibfahn@gmail.com>

Adds a centered logo to the README to make it a little more festive. As centering is not possible in pure Markdown, a bit of HTML is used. PR-URL: nodejs#12148 Ref: nodejs#6920 Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Anna Henningsen <anna@addaleax.net> Reviewed-By: Luigi Pinca <luigipinca@gmail.com> Reviewed-By: Colin Ihrig <cjihrig@gmail.com> Reviewed-By: Yuta Hiroto <hello@about-hiroppy.com> Reviewed-By: Richard Lau <riclau@uk.ibm.com> Reviewed-By: Italo A. Casas <me@italoacasas.com> Reviewed-By: Gibson Fahnestock <gibfahn@gmail.com>

Adds a centered logo to the README to make it a little more festive. As centering is not possible in pure Markdown, a bit of HTML is used. PR-URL: #12148 Ref: #6920 Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Anna Henningsen <anna@addaleax.net> Reviewed-By: Luigi Pinca <luigipinca@gmail.com> Reviewed-By: Colin Ihrig <cjihrig@gmail.com> Reviewed-By: Yuta Hiroto <hello@about-hiroppy.com> Reviewed-By: Richard Lau <riclau@uk.ibm.com> Reviewed-By: Italo A. Casas <me@italoacasas.com> Reviewed-By: Gibson Fahnestock <gibfahn@gmail.com>

Adds a centered logo to the README to make it a little more festive. As centering is not possible in pure Markdown, a bit of HTML is used. PR-URL: nodejs/node#12148 Ref: nodejs/node#6920 Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Anna Henningsen <anna@addaleax.net> Reviewed-By: Luigi Pinca <luigipinca@gmail.com> Reviewed-By: Colin Ihrig <cjihrig@gmail.com> Reviewed-By: Yuta Hiroto <hello@about-hiroppy.com> Reviewed-By: Richard Lau <riclau@uk.ibm.com> Reviewed-By: Italo A. Casas <me@italoacasas.com> Reviewed-By: Gibson Fahnestock <gibfahn@gmail.com>

Trott · 2017-07-31T05:01:23Z

This issue has been inactive for sufficiently long that it seems like perhaps it should be closed. Feel free to re-open (or leave a comment requesting that it be re-opened) if you disagree. (Or just make the changes to README and open a PR! :-D ) I'm just tidying up and not acting on a super-strong opinion or anything like that.

eljefedelrodeodeljefe added the doc Issues and PRs related to the documentations. label May 21, 2016

eljefedelrodeodeljefe added the help wanted Issues that need assistance from volunteers or PRs that need help to proceed. label May 24, 2016

silverwind mentioned this issue Mar 31, 2017

doc: add logo to README #12148

Closed

2 tasks

Trott closed this as completed Jul 31, 2017

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

doc: intent to restructure README.md to be more advertising and introducing to docs #6920

doc: intent to restructure README.md to be more advertising and introducing to docs #6920

eljefedelrodeodeljefe commented May 21, 2016 •

edited

Loading

claudiorodriguez commented May 21, 2016

eljefedelrodeodeljefe commented May 24, 2016

eljefedelrodeodeljefe commented May 24, 2016

preco21 commented May 24, 2016

ghost commented May 24, 2016

eljefedelrodeodeljefe commented May 24, 2016

silverwind commented May 24, 2016 •

edited

Loading

ghost commented May 24, 2016 •

edited by ghost

Loading

silverwind commented May 24, 2016 •

edited

Loading

silverwind commented May 24, 2016

eljefedelrodeodeljefe commented May 24, 2016

eljefedelrodeodeljefe commented May 24, 2016

preco21 commented May 24, 2016

claudiorodriguez commented May 25, 2016

kravelin commented Mar 18, 2017

lpinca commented Mar 18, 2017

silverwind commented Mar 18, 2017 •

edited

Loading

silverwind commented Mar 31, 2017

Trott commented Jul 31, 2017

doc: intent to restructure README.md to be more advertising and introducing to docs #6920

doc: intent to restructure README.md to be more advertising and introducing to docs #6920

Comments

eljefedelrodeodeljefe commented May 21, 2016 • edited Loading

claudiorodriguez commented May 21, 2016

eljefedelrodeodeljefe commented May 24, 2016

Node.js

eljefedelrodeodeljefe commented May 24, 2016

preco21 commented May 24, 2016

ghost commented May 24, 2016

eljefedelrodeodeljefe commented May 24, 2016

silverwind commented May 24, 2016 • edited Loading

ghost commented May 24, 2016 • edited by ghost Loading

silverwind commented May 24, 2016 • edited Loading

silverwind commented May 24, 2016

eljefedelrodeodeljefe commented May 24, 2016

eljefedelrodeodeljefe commented May 24, 2016

preco21 commented May 24, 2016

claudiorodriguez commented May 25, 2016

kravelin commented Mar 18, 2017

lpinca commented Mar 18, 2017

silverwind commented Mar 18, 2017 • edited Loading

silverwind commented Mar 31, 2017

Trott commented Jul 31, 2017

eljefedelrodeodeljefe commented May 21, 2016 •

edited

Loading

silverwind commented May 24, 2016 •

edited

Loading

ghost commented May 24, 2016 •

edited by ghost

Loading

silverwind commented May 24, 2016 •

edited

Loading

silverwind commented Mar 18, 2017 •

edited

Loading