search

precice / precice.github.io

The website of preCICE
https://precice.org/
12 stars 56 forks source link

Sidebar folder overview url #342

Open fsimonis opened 4 months ago

fsimonis commented 4 months ago

When generating breadcrumbs for #341, I realized that our Folders don't have a URL assigned to them.

This leads to a missing hierarchy in the breadcrumbs.

Example configuration-xml-reference.html has breadcrumbs Docs > XML Reference as there is no url assigned to the "Configuration" Folder. It should really have breadcrumbs Docs > Configuration > XML Reference.

suggestion

Consistently add an overview_url: for folders or similar to define such an overview. Then we can use it in the breadcrumb generation.

fsimonis commented 2 months ago

Today I realized that the GitHub documentation uses folders in there sidebars too.

Each folder has an invisible landing page that lists the content of the folder: https://docs.github.com/en/actions/using-workflows

Could we create something like this automatically? Would it add any value aside from navigation?

MakisH commented 2 months ago

Would it add any value aside from navigation?

Mostly being able to link to a specific section, which is what our overview pages are currently for.

We currently have manual overview pages wherever this makes sense, while the rest of the folders (e.g., basic/advanced configuration) are mostly for keeping the sidebar short. Unless there are SEO reasons, let's not invest any effort here.

fsimonis commented 2 months ago

Unless there are SEO reasons, let's not invest any effort here.

SEO is the only reason for doing this as it gives the site a structure. Currently the entire doc is a flat hierarchy. Having pages for folders would allow add this hierarchy.

I don't see any user-facing outside of potentially (big asterisk) better search results.

fsimonis commented 2 months ago

Unless there are SEO reasons, let's not invest any effort here.

SEO is the only reason for doing this as it gives the site a structure. Currently the entire doc is a flat hierarchy. Having pages for folders would allow add this hierarchy.

I don't see any user-facing improvement outside of potentially (big asterisk) better search results.