Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

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

Open
finanalyst opened this issue Jun 20, 2024 · 0 comments
Open

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

finanalyst opened this issue Jun 20, 2024 · 0 comments

Comments

@finanalyst
Copy link
Collaborator

@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?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant