README header links about integration-guides

[curquiza]

I don't really like (from my POV) the list of links because I want the users to see asap the Getting Started with less scroll as possible.

As a first version, I'm going to add the roadmap to the headers in a really simple way (between "Documentation" and "Website").
Then, as a second step, I'm going to organize a quick meeting with the integration team to discuss together the improvements 🙂 (we'll ask you before applying any change of course, @qdequele)
The goal of doing two steps is to integrate as quickly as possible the roadmap link in the READMEs, and then, spend time on presentation details.

About the sandbox: since the sandbox cannot welcome more than 21 users, I'm not going to update all the README with it for the moment.

[curquiza]

I agree, this kind of information is important.

The current header looks like this:

Maybe adding two other information would be a little bit "heavy".
Don't you think we should also remove some of the current header titles? So, we can add the roadmap and the sandbox and the users could better see them.
Or maybe someone wants to suggest another display?

FYI: I've almost finished a tool that allows us to update the "generic" files in all the repositories with one script!

[bidoubiwa]

We could add the sandbox in the Run MeiliSearch category and add Roadmap in the headings.
About the headings to remove, I think blog and twitter should not be there. But mostly twitter if we do not want to remove everything.

When looking at some other repos this is what they have in their heading:

Algolia

Stripe : No headings

Strapi: Completely different

Armory

Nuxt JS

Based on the fact that no one has a clear idea of what to add on their Readme, I would suggest we do it how we think its best.

I suggest the following:

• MeiliSearch
• Documentation
• RoadMap
• Website
• FAQ
• Community Slack

[curquiza]

We could add the sandbox in the Run MeiliSearch category and add Roadmap in the headings.

Agreed!

I suggest the following:

* MeiliSearch

* Documentation

* RoadMap

* Website

* FAQ

* Community Slack

I'm not sure to understand what you suggest exactly, to keep the same headers display we have right now?
The comparison with strapi and nuxt is not really relevant for our SDKs READMEs: they correspond more to the MeiliSearch repo than to our SDK repos. That's why strapi has the deploy badges. And nuxt is more a "presentation" repo than a "how to use nuxt", that's why they can afford to put a list without making the README really heavy.

The slack link is already added in the badges, thanks to the slack logo it's easier to spot it from my POV:

Otherwise, the order you sugggest is good to me 🙂

[qdequele]

I prefer, for things that matter, like links we want to put forward, a vertical reading.

So we could keep for each repository their specific tools label on top:

[ Build | Passing ] [ Report | A+ ] [ License | MIT ] [ BORS | enabled ] [ Codecov | 100% ]

And add under that, some links like Nuxt does:

• ⚙️ MeiliSearch
• 📘 Documentation
• 📌 Roadmap
• 🕹 Sandbox
• 💬 Slack

What do you think? It may be too much like the table of contents.

[bidoubiwa]

It might be more visible:

I'm not sure which one I prefer

[curquiza]

The simple version was implemented. If we need a better header, we will reopen an issue.