Clickable breadcrumbs

[rschu1ze]

The top of any documentation page shows a breadcrumbs menu, e.g. for the settings documentation page:

The breadcrumbs are no clickable links but they ideally should be.

[Blargian]

@rschu1ze I believe this happens because not every link has an associated markdown page called index.md. Breadcrumb here for instance is clickable up one level because there is an index.md file for Geo but none for Regular Functions or Functions.

On a related note: it looks strange that in places the path is something like Functions\Table Functions\Table Functions rather than just Functions\Table Functions.

[rschu1ze]

Nice find, thanks.

index.md may or may not be useful:

• E.g. here (the first screenshot in your previous comment), index.md merely enumerates the documented functions again. That's more or less redundant. Worse, index.md needs to be maintained and kept in sync with the actually existing functions by hand. In the case of the Geo functions, the left sidebar mentions "SVG" as a Geo function but index.md doesn't link "SVG".
• In the case of "Table Functions" (the second screenshot), index.md adds value and context. Note that linking actual table functions would create redundancy and double-maintenance again.

I think we should have only index.md-s of the second category.

@Blargian If you find some time, feel free to go through the docs and check all index.md-s. I'll attach screenshots of a few places that look weird but there are surely more.

[Blargian]

from /docs/en/ -> find sql-reference -maxdepth 100 -name 'index.md':

Path	Type 1
sql-reference/table-functions/index.md
sql-reference/functions/geo/index.md	X
sql-reference/functions/index.md
sql-reference/operators/index.md
sql-reference/window-functions/index.md
sql-reference/index.md
sql-reference/aggregate-functions/reference/index.md	X
sql-reference/aggregate-functions/index.md
sql-reference/statements/select/index.md	X (Type 2 but contains list)
sql-reference/statements/alter/index.md
sql-reference/statements/create/index.md	X
sql-reference/statements/index.md	X
sql-reference/data-types/domains/index.md
sql-reference/data-types/index.md	X
sql-reference/data-types/special-data-types/index.md
sql-reference/data-types/nested-data-structures/index.md

[rschu1ze]

@Blargian To resolve redundancy in index.md files, I pushed ClickHouse/ClickHouse#71730.

[rschu1ze]

Guess we can't do much about breakcrumbs without moving content between pages. Not worth the trouble, closing.

[Blargian]

@rschu1ze I messed around with docusaurus today and have found a way to make breadcrumbs clickable through docusaurus configuration. I'll need to go through the docs and add index.md files in some places but I think it's quite achievable for the most part. Will open a PR when I get a chance later in the week.