Hydrogen: Improve our README structure

Created on 21 Mar 2017  路  5Comments  路  Source: nteract/hydrogen

Our README has a lot of valuable information. Though it's a bit unstructured at the moment. I think we should either move a few sections into separate files or provide a table of content on the top.

For example:
https://github.com/RichardLitt/standard-readme
https://github.com/jakubroztocil/httpie

documentation good first issue

All 5 comments

@willingc Thanks for the link!

To start the ball rolling I added a "Contents" header with links to each section to my fork.

I think this small step helps organize a fairly lengthy README.

@BenRussert Looks good and the extra navigation helps.

Two small suggestions:

  • Move the GIF up higher under so folks can see it without scrolling. I would grab the sentence about the Medium blog post with the image. So it would flow:

    • Title

    • badges

    • The intro sentence "This package lets you run your code ..."

    • "Checkout our Medium blog post to see what you can do with Hydrogen."

    • GIF

    • Contents

    • Background (less what was moved higher)

  • At the very end of the file, it might be nice to add a "Return to top" link that brings you to the contents or top of file.

Nice job 馃憤

@willingc Great points. I made these changes and opened a pr.

Was this page helpful?
0 / 5 - 0 ratings

Related issues

Mungoid picture Mungoid  路  4Comments

HaoranXue picture HaoranXue  路  4Comments

neurotronix picture neurotronix  路  4Comments

wadethestealth picture wadethestealth  路  3Comments

danbri picture danbri  路  4Comments