Uploaded image for project: 'Fluid Infusion'
  1. Fluid Infusion
  2. FLUID-5721

The documentation platform needs a better way of generating navigation

    XMLWordPrintable

    Details

    • Type: Bug
    • Status: Open
    • Priority: Major
    • Resolution: Unresolved
    • Affects Version/s: None
    • Fix Version/s: None
    • Component/s: Docs platform
    • Labels:
      None

      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.

        Attachments

          Activity

            People

            Assignee:
            Unassigned Unassigned
            Reporter:
            jhung Jonathan Hung
            Votes:
            0 Vote for this issue
            Watchers:
            0 Start watching this issue

              Dates

              Created:
              Updated: