Proposal: Always add "Home / Module Index / Search" button

[jstriebel]

It would be great to have a button leading to the top-level index-page in lower-nested pages by default. Not sure what would be the nicest way visually, I just added a simple text button, but also a home or search-magnification icon could be used, maybe even without any text.

A simple icon without text would also prevent more line-breaks:

I'm sorry if this proposal is too specific, I just thought it might be useful in the default templates.

[jstriebel]

Having a search bar as proposed in #23 would be even nicer and supersede this.

[mhils]

Thanks for raising this! How would you feel about a permanent Module Index button replacing the "go one layer up" button on submodules? Maybe that's the more useful button in general.

[jstriebel]

Thanks for raising this! How would you feel about a permanent Module Index button replacing the "go one layer up" button on submodules? Maybe that's the more useful button in general.

Good idea, I think that's more useful. However, I'm not sure if I'd expect to go to the index-page with the search or the modules documentation. Maybe buttons for both? E.g. I'd actually expect https://pdoc.dev/docs/pdoc.html to be the "home" page (or Module Index), but https://pdoc.dev/docs/ provides the search and should be accessible from everywhere (until there's a search bar).

[mhils]

Good idea, I think that's more useful. However, I'm not sure if I'd expect to go to the index-page with the search or the modules documentation.

Ah, yes. That's a very good point to make. Thanks!

Given the circumstances I'd lean towards keeping the current setup We will eventually add a search bar that does things proper, until then I'm inclined not to introduce temporary stopgaps. :)

Thank you anyhow for the PR. I hope you don't mind keeping that around in your local config. 😃