Raku / doc-website

Tooling to build/run the documentation website
Artistic License 2.0
7 stars 10 forks source link

How much information should be in Table of contents? #399

Open finanalyst opened 2 months ago

finanalyst commented 2 months ago

@0rir mentioned in the SF Raku Study group that the Table of Contents at one time contained links to pages related to the "present" page.

When adapting the website to new tooling, this issue was raised.

The PRO is that a new user can see links to related material not easily found with a keyword search

The CONs are:

  1. Some pages generate a huge amount of data swamping the actual headings on the "present" page
  2. How much depth should the links go, eg. to methods of classes next down in the hierarchy, or methods of all underlying classes down to eg Mu. ?
  3. The class hierarchy for Type pages is contained in the Typegraph diagram.

I can see that this information would be useful, but rather than putting it in the Table of Contents, may be it could be included in a 'Related' tab, like the 'Index' is in the ToC tab ?

Is this an idea worth pursuing?