Script to generate a recursive ToC in the top-level readme

[moul]

To make it easier to find what we need using ctrl+f in the main doc.

It would be great to include both the title and a description.

[moul]

Seems to be appropriate: https://github.com/MayasHaddad/markdown-toc-folders

[zivkovicmilos]

I tried out this tool, it does a recursive decent and generates the ToC, but the bullet points are off.

If for example a there is a H1 inside file.md, it doesn't give you information that it's under file.md, but just bundles the H1 with other H1s from other files. For ex:

file1.md:
# Hello

file2.md:
# World

The output would be:

# Hello (link)
# World (link

Does this look alright to you?
If we want something more fine grained, we'd need to write it ourselves

[zivkovicmilos]

I will open up a draft PR and se can discuss

EDIT:
#21

[ajnavarro]

To make it easier to find what we need using ctrl+f in the main doc.

BTW, when you render the markdown to HTML search feature is available and it is quite good.