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

Left nav issues #123

Open
eric-schneider opened this issue Apr 25, 2024 · 1 comment
Open

Left nav issues #123

eric-schneider opened this issue Apr 25, 2024 · 1 comment
Assignees
Labels
bug Something isn't working P0

Comments

@eric-schneider
Copy link
Contributor

eric-schneider commented Apr 25, 2024

There are two major issues with the left nav.

Parent nav items can't be links

The UI currently doesn't support the following nav configuration:

* xref:parent-page.adoc[]
** xref:child-page.adoc[]

The parent page doesn't present as a link. This has forced us to use an undesirable workaround of making the parent page a child of itself, for example:

* Parent page
** xref:parent-page.adoc[]
** xref:child-page.adoc[]

image

A list title is required

IMPORTANT: As @mlr pointed out below, this should be fixed as of #103.

Currently, the UI requires the nav to have at least one list title element, otherwise it won't render anything at all.

✅ Does render

.Some title
* xref:page-1.adoc
* xref:page-2.adoc
* xref:page-3.adoc
* xref:page-4.adoc

❌ Does not render

* xref:page-1.adoc
* xref:page-2.adoc
* xref:page-3.adoc
* xref:page-4.adoc

Some products don't have enough pages to warrant using list titles. However, we've had to add at least one so that nav will at least show the pages in the first place:

image
@eric-schneider eric-schneider added bug Something isn't working P0 labels Apr 25, 2024
@mlr
Copy link
Contributor

mlr commented Apr 25, 2024

A list title is required
Currently, the UI requires the nav to have at least one list title element, otherwise it won't render anything at all.

A list title shouldn't be required anymore as of #103

See the streaming doc sub sites as an example of this. We still render the links, they just don't have a title or parent drop down.

Example: https://docs-stage.datastax.com/en/streaming/index.html
Relevant nav: https://raw.githubusercontent.com/DataStaxDocs/datastax-streaming-docs-site/main/site-main/modules/ROOT/nav.adoc

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Something isn't working P0
Projects
None yet
Development

No branches or pull requests

3 participants