FLUID-5721: The documentation platform needs a better way of generating navigation

Metadata

Source
FLUID-5721
Type
Bug
Priority
Major
Status
Closed
Resolution
Migrated
Assignee
N/A
Reporter
Jonathan Hung
Created
2015-07-28T14:19:19.963-0400
Updated
2024-07-31T16:21:54.674-0400
Versions
N/A
Fixed Versions
N/A
Component
  1. Docs platform

Description

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 docpad's Collections ability to define groups of documents.

Comments