[PoC] Single page documentation

[lslezak]

Details

• Render all documentation on a single page for easy search
• See the rendered preview: user documentation, developer documentation

TODO

• Fix the broken links inside the single page documents
• Missing top level headings in the page TOC (see the discussion below)
• Could we generate the single page content somehow automatically? If we add a new page it needs to be added to the single page version as well, that is error prone...
• Where to place/link the single page documentation? Is the current place OK?

[mvidner]

As Lukas has pointed out on IRC, in the rendered page, the navigation list in the right sidebar is missing the main headlines, those that correspond to the file titles in the paginated docs

[lslezak]

Those headings are <H1> and although Docusaurus allows configuring the min and max levels displayed in the TOC it requires the min level to be greater than or equal to 2, level 1 is not allowed. 😟

A possible workaround could be shifting all headings one level down (H+1)...

[kobliha]

@lslezak Your idea would help a lot with keeping the NotebookLM stuffed with up-to-date data. Without this, it all depends on manual updates whenever someone moves an old or creates a new page. And that is not reliable.

[dgdavid]

Hi guys!

I stumbled upon this almost by accident this week :) I'm not sure what the plans are for continuing this work, but here are my two cents: I'd suggest keeping the multi-page site available and as the default option. I'd offer single-page as an option similarly to WHATWG HTML does. It works well to provide a multi-page version for regular browsing and an optional single-page version for special use cases.

From a user perspective, a well-organized multi-page site is often easier to navigate and faster to load. That said, a single-page version can be useful for:

• Performing a global search directly in the browser via Ctrl+F
• Feeding content to AI tools, as mentioned above
• Creating an e-book
• Other use cases

I believe Docusaurus might have hooks or plugins to generate a single-page version using the sidebars.ts
file, though I haven’t checked.

So, if this work continues, please consider offering both versions instead of replacing the multi-page site entirely.