docs: table of contents

[jacobhq]

Context & Description

Fixes #343

• Avoid layout shift
• Shorten headings
• Generate heading IDs that don't include [Object object] when using headings with code in them

Device Screenshots

Mobile

Desktop

[jacobhq]

• Avoid layout shift
• Shorten headings

[Valerioageno]

Hey @jacobhq, thanks for it!

1. Can you add a screenshot?
2. We should try to deliver the full feature on the first try since it doesn't make much sense to deliver a buggy experience. Could you please also address the two remaining tasks you defined before the review?

[jacobhq]

As you can see in the desktop screenshot, the long headings look quite ugly. Maybe I should not include lower heading levels in the index?

There is also issues when there are headings with the same id (same content), for example https://tuono.dev/documentation/installation#installation. Should I just manually change those docs pages?

[jacobhq]

Working example

2025-01-22-17-16-40.mp4

Problems with heading IDs

2025-01-22-17-17-37.mp4

I will write a thing to generate heading IDs later this evening, then the PR will be ready.

[Valerioageno]

Hey! Thanks for this.
I'm locally test it! I'll let you know next days!

[Valerioageno]

I found a couple of bugs! Do you mind if I add a commit with some UI improvement, and then we address the bugs?

[jacobhq]

Yeah sure!