elastic / elastic/docs-builder

Strategy for nav headings that make sense in one context but not in another

Open
#621 1 comment 1 reaction 0 assignees View on GitHub
ai-triaged ai:eng-question ai:ux-question ai:writer-question
Dominant language
C#
Stars
24
Forks
44
Avg merge
1d 7h
Merged PRs (30d)
146

Description

## Summary

Slack thread: https://elastic.slack.com/archives/C05PP2LEC1X/p1740602224538949?thread_ts=1740532178.416139&cid=C05PP2LEC1X

Doc previews currently take all of the content and build it together. This means if you have reference content, release notes, and deprecations, it all gets built to one preview in the preview. For example:

![Image](https://github.com/user-attachments/assets/339e22b0-d7bd-4555-8e09-50eaed84376e)

In this screenshot, you'll notice that the release notes and deprecations nav headings are not helpful—hey're just the product name. That's because in the site-wide IA, these nav headings are nested under headings like "Release notes" and "Deprecations". Something like this:

![Image](https://github.com/user-attachments/assets/fbfb814a-d8a2-4de8-a62f-8b453c6e4b41)

## Question

What can we do to improve this experience where a navigation_heading makes sense in the context of the assembler build, but not in the context of the preview build?

Contributor guide

Open the contributing guide

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.