search

fluid-project / infusion-docs

Documentation space for Infusion
http://docs.fluidproject.org/infusion
Creative Commons Attribution 4.0 International
8 stars 45 forks source link

The documentation platform needs a better way of generating navigation #288

Open jobara opened 3 months ago

jobara commented 3 months ago

Currently navigation in the documentation platform is a manual process. site-structure.json defines the structure with groupings, titles, and URLs. This structure is very fragile because:

  1. If the titles do not match the titles in the documents, an active indicator will not appear in the sidebar navigation.
  2. If the URL is incorrect in the site-structure.json file, you will no know there is a problem until manually encountered.

A more robust or automatic method of generating navigation should be used. Consider using 11ty's navigation and/or collections.

Additional context or notes

Originally filed as FLUID-5721 by @jhung on July 28, 2015.

greatislander commented 3 months ago

@jobara I might be able to look at this in August.

jobara commented 3 months ago

@jobara I might be able to look at this in August.

That'd be great. I was thinking it might make sense along side an update to 11ty 3.0 but it could happen earlier too.

jobara commented 3 months ago

Relates to #191 and #307