Skip to content

Improve docs navigation hierarchy #207

@jpetey75

Description

@jpetey75

We should make more improvements to the left nav in docs.

Specifically, BI feature guides and Developer guides are the categories that get too long and the docs in side them don't all go together perfectly.

IMO we shouldn't add another layer of categories, but we can definitely add more second-level categories. For example, this PR splits the AI agent BI feature into its own category and breaks up the docs into multiple pages: #201

Maybe the top level should be called Developer guides instead of Build your semantic layer and the sub-categories would be something like:

  • Lightdash developer quickstart
  • Lightdash semantic layer (add a callout at the top to redirect people to SL reference since this is more of a marketing page)
  • Lightdash semantic layer reference (needs a home page with cards to link to metrics, dimensions, tables, joins, etc.)
  • Managing content for Preview projects, dashboards as code, validation, renaming models and fields, etc.
  • other stuff...?

We should probably move dbt write-back and dbt model best practices into a new dbt category under Integrations as well.


In addition to re-org, when we are happy with a new structure we should update the folder categorization in this project and also update URLs for all the individual docs. Anything that changes folders and/or slugs needs to be added as redirects so links in the app and elsewhere don't break https://www.mintlify.com/docs/create/broken-links

Metadata

Metadata

Assignees

No one assigned

    Labels

    documentationImprovements or additions to documentation

    Type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions