Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

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

Open
jobara opened this issue Jul 31, 2024 · 3 comments
Open
Assignees
Labels
enhancement New feature or request

Comments

@jobara
Copy link
Member

jobara commented Jul 31, 2024

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.

@jobara jobara added the enhancement New feature or request label Jul 31, 2024
@greatislander
Copy link
Contributor

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

@greatislander greatislander self-assigned this Aug 1, 2024
@jobara
Copy link
Member Author

jobara commented Aug 1, 2024

@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
Copy link
Member Author

jobara commented Aug 1, 2024

Relates to #191 and #307

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

2 participants