Gitmoji: โœจ Add 'Tools' page to the website

Created on 12 Jul 2020  ยท  8Comments  ยท  Source: carloscuesta/gitmoji

Hello @carloscuesta :sunglasses:!

All the useful tools related to gitmoji are located in a the README. It could be great if we add a dedicated page for them in the website and it's link near Github and Tweet.

The different tools can be stored in a json file with this structure :

[
  {
    name : string, 
    description : string, 
    links : [
      {
       label : string,
       url : string
      }, 
      ... 
    ]
  }, 
  ... 
]

And then we could just parse it and render a nice list.

What do you think about this idea ?

improvement

Most helpful comment

couldn't we render the README as the about page :thinking:

All 8 comments

couldn't we render the README as the about page :thinking:

Yes I think we could also do that ๐Ÿ‘

So after the discussion in #516 it would be preferable to implement a tools page rather than rendering the README. The section related tools will be remove from the README but probably we will add a link to this new page.

Is the json structure ๐Ÿ‘Œ for you @carloscuesta @vhoyer or did I miss something ?

I wouln't allow adding an array of links I would set the structure to something like:

[
  {
    name: string,
    description: string,
    link: string
  }
]

@carloscuesta yes it would be easier to maintain but what if you want to provide the tools as a website but also a link to the github repo ? Would be friendlier for the developer to be able to provide max 3-4 links don't you think so ?

I think we should enforce a format to avoid having some projects with one link and some others with more than one.

IMHO a single link should be enough since from that link you could add any other links you want.

This would make the list much more consistent for the users that are looking at it.

Ok I agreed with that @carloscuesta ๐Ÿ‘ have you an idea for the design ? Any requirements ?

I would create a page like the about one, with an explanatory text of what the list includes and then rendering the list like at the readme

Was this page helpful?
0 / 5 - 0 ratings

Related issues

Tydax picture Tydax  ยท  29Comments

johannchopin picture johannchopin  ยท  18Comments

elliot-nelson picture elliot-nelson  ยท  35Comments

kevtan picture kevtan  ยท  12Comments

mikemarsian picture mikemarsian  ยท  14Comments