Add TOC section for packages with n+ (sub)commands?

[diggy]

For packages with a lot of (sub)commands, it could be useful to have a concise TOC section (table of contents), cf. e.g. the readme of https://git.io/v5THM

[danielbachhuber]

@diggy It's not super clear what you're referring to in that repo. Can you share a screenshot?

[diggy]

@danielbachhuber packages with a lot of (sub)commands have a rather extensive readme, making it nearly impossible to inspect package features at a glance (think end user); hence my proposal to insert a TOC section (before Using) to give a quick overview, maybe if the n° of commands hits a certain limit

[danielbachhuber]

packages with a lot of (sub)commands have a rather extensive readme, making it nearly impossible to inspect package features at a glance (think end user);

Oh, I see. Yes, I agree with this.

hence my proposal to insert a TOC section (before Using) to give a quick overview, maybe if the n° of commands hits a certain limit

👍 From me.

[swissspidy]

FWIW, GitHub already shows a table of contents:

Related: #227

[danielbachhuber]

@swissspidy Hm, do you suggest wontfix then?

@ernilambar What do you think?

[ernilambar]

@danielbachhuber I am leaning towards wontfix.

[swissspidy]

Same