Add `PrimaryNav` feature #604

reakaleek · 2025-02-25T11:32:54Z

Add a feature flag PrimaryNav which enables the custom primary navigation and splits the pages navigation needed for production.
When it's disabled, it shows the full navigation (as before).

Configuration Enhancements:

Added a new Features dictionary to the ConfigurationFile class to support feature toggles.

Htmx Class Updates:

Updated the Htmx class to include methods that utilize the new Features dictionary for dynamic configuration of attributes.

Navigation and HTML Rendering Improvements:

Modified the HtmlWriter class to cache rendered navigation HTML and utilize the new configuration features for conditional rendering.
Updated various HTML rendering methods to use the new MarkdownParser instance method instead of static methods.

Markdown Parsing and Rendering:

Refactored the MarkdownParser class to use instance methods and accept a BuildContext for dynamic configuration.
Updated the HtmxLinkInlineRenderer class to use the new configuration features and dynamic attributes.

Miscellaneous:

Minor CSS adjustments to improve text wrapping and inline-block behavior.
Added support for trailing slashes in navigation item links in pages-nav.ts.
Ensured the current navigation item is scrolled into view and the window is scrolled to the top.

Results

PrimaryNav feature enabled

docs-content-nav.mp4

PrimaryNav feature disabled

docs-builder-nav.mp4

Mpdreamz · 2025-02-27T11:56:14Z

.github/workflows/preview-build.yml

@@ -133,23 +133,21 @@ jobs:
      - name: Build documentation
        if: github.repository != 'elastic/docs-builder' && (steps.deployment.outputs.result || (steps.check-files.outputs.any_modified == 'true' && github.event_name == 'merge_group'))
        uses: elastic/docs-builder@main
-        id: docs-build


I think a merge went bad here? we want to keep these changes from main

Yup, something went wrong. Thank you for bringing this to my attention!

Mpdreamz · 2025-02-27T11:56:42Z

actions/generator/action.yml

@@ -0,0 +1,16 @@
+name: 'Documentation Generator'


likewise this should be deleted

actions/update-reference-index/action.yml should be undeleted

Mpdreamz · 2025-02-27T11:57:21Z

docs-builder.sln

@@ -60,17 +60,6 @@ Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "validate-inbound-local", "v
 		actions\validate-inbound-local\action.yml = actions\validate-inbound-local\action.yml
 	EndProjectSection
 EndProject
-Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "update-link-index", "update-link-index", "{6554F917-73CE-4B3D-9101-F28EAA762C6B}"


keep the changes to this file

Mpdreamz · 2025-02-27T11:58:14Z

docs/_docset.yml

@@ -9,6 +9,10 @@ subs:
  serverless-short: Serverless
  ece:   "Elastic Cloud Enterprise"
  eck:   "Elastic Cloud on Kubernetes"
+
+#features:
+#  PrimaryNav: true


primary-nav? We default to kebab-case (dash-case) for yaml

src/Elastic.Markdown/IO/Configuration/ConfigurationFile.cs

src/Elastic.Markdown/Myst/MarkdownParser.cs

Mpdreamz · 2025-02-27T12:02:16Z

src/Elastic.Markdown/Slices/Layout/_Breadcrumbs.cshtml

-			href="@Model.UrlPathPrefix/"
-			hx-get="@Model.UrlPathPrefix/"
-			hx-select-oob="@Htmx.GetHxSelectOob()"
+			href="@Model.Link("/")"


❤️ much needed

docs/_docset.yml

Mpdreamz

Two more nitpicks

Mpdreamz · 2025-02-27T12:48:30Z

src/Elastic.Markdown/Slices/HtmlWriter.cs

+
+		string? navigationHtml;
+
+		if (DocumentationSet.Configuration.Features.ContainsKey("primary-nav"))


Lets have a static class with constant string properties so we can use Features.PrimaryNavigation.

ee10395

Instead of a static constant I created a class.

which can be used like

if (features.IsPrimaryNavEnabled) { ... }

WDYT?

Mpdreamz · 2025-02-27T12:53:08Z

src/Elastic.Markdown/Slices/HtmlWriter.cs

+			Tree = group ?? DocumentationSet.Tree,
+			CurrentDocument = markdown,
+			IsRoot = topLevelGroupId == DocumentationSet.Tree.Id,
+			Configuration = configuration


Since we only use this in GetHxSelectOob to get the features, set the features on the model and not the whole Configuration?

This reverts commit 8edd22a.

reakaleek marked this pull request as ready for review February 25, 2025 11:54

reakaleek marked this pull request as draft February 25, 2025 11:54

reakaleek changed the title ~~Primary Nav PoC~~ Add PrimaryNav feature Feb 27, 2025

reakaleek added the feature label Feb 27, 2025

reakaleek self-assigned this Feb 27, 2025

Add latest header design and adjust pages navigation

745486b

reakaleek force-pushed the feature/header-design-pt2 branch from edd2fc9 to 745486b Compare February 27, 2025 11:06

reakaleek marked this pull request as ready for review February 27, 2025 11:09

reakaleek requested review from Mpdreamz and a team February 27, 2025 11:09

Mpdreamz requested changes Feb 27, 2025

View reviewed changes

reakaleek and others added 4 commits February 27, 2025 13:19

Fix unintended merge changes

0f109dc

fix

2c65048

Pass markdownparser to directive html renderer

42855f9

Change feature flag from UpperCamelCase to kebab-case

b36d7d6

reakaleek requested a review from Mpdreamz February 27, 2025 12:40

reakaleek commented Feb 27, 2025

View reviewed changes

docs/_docset.yml Outdated Show resolved Hide resolved

Update docs/_docset.yml

549d490

Mpdreamz requested changes Feb 27, 2025

View reviewed changes

Refactor feature flags

ee10395

reakaleek requested a review from Mpdreamz February 27, 2025 13:35

Mpdreamz approved these changes Feb 27, 2025

View reviewed changes

reakaleek merged commit 8edd22a into main Feb 27, 2025
5 checks passed

reakaleek deleted the feature/header-design-pt2 branch February 27, 2025 13:48

reakaleek mentioned this pull request Feb 27, 2025

Enable primary-nav feature elastic/docs-content#615

Open

reakaleek added a commit that referenced this pull request Feb 27, 2025

Revert "Add PrimaryNav feature (#604)"

94eeb65

This reverts commit 8edd22a.

reakaleek mentioned this pull request Feb 27, 2025

Revert "Add PrimaryNav feature" #635

Merged

reakaleek added a commit that referenced this pull request Feb 27, 2025

Revert "Add PrimaryNav feature (#604)" (#635)

57d6cfd

This reverts commit 8edd22a.

reakaleek restored the feature/header-design-pt2 branch February 27, 2025 14:08

reakaleek mentioned this pull request Feb 27, 2025

Add primary-nav feature #636

Open

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add `PrimaryNav` feature #604

Add `PrimaryNav` feature #604

reakaleek commented Feb 25, 2025 •

edited

Loading

Mpdreamz Feb 27, 2025

reakaleek Feb 27, 2025

reakaleek Feb 27, 2025

Mpdreamz Feb 27, 2025

Mpdreamz Feb 27, 2025

reakaleek Feb 27, 2025

Mpdreamz Feb 27, 2025

reakaleek Feb 27, 2025

Mpdreamz Feb 27, 2025

reakaleek Feb 27, 2025

Mpdreamz Feb 27, 2025

Mpdreamz left a comment

Mpdreamz Feb 27, 2025

reakaleek Feb 27, 2025 •

edited

Loading

Mpdreamz Feb 27, 2025

reakaleek Feb 27, 2025


		string? navigationHtml;

		if (DocumentationSet.Configuration.Features.ContainsKey("primary-nav"))

Add PrimaryNav feature #604

Add PrimaryNav feature #604

Conversation

reakaleek commented Feb 25, 2025 • edited Loading

Configuration Enhancements:

Htmx Class Updates:

Navigation and HTML Rendering Improvements:

Markdown Parsing and Rendering:

Miscellaneous:

Results

PrimaryNav feature enabled

PrimaryNav feature disabled

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Mpdreamz left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

reakaleek Feb 27, 2025 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Add `PrimaryNav` feature #604

Add `PrimaryNav` feature #604

reakaleek commented Feb 25, 2025 •

edited

Loading

reakaleek Feb 27, 2025 •

edited

Loading