Fix/apidocs breadcrumb toc asf#1232
Merged
Merged
Conversation
Introduces _navbarLinks and _asfLinks configuration in docfx.json including the correct event page link. Adds a new navbar-links partial to render these links and updates the main navbar partial to include it.
Now the Api / Libraries works as intended, not splitting into two lines and the slash is restored.
Introduces _navbarLinks and _asfLinks configuration in docfx.global.json including the correct event page link. Adds a new navbar-links partial to render these links and updates the main navbar partial to include it.
- Added docfx.links.json to organize navigation and ASF links separately. It now includes the links. - Modified docfx.site.json to include docfx.links.json in globalMetadataFiles.
Added docfx.links.json to metadata and updated navbar links to point to the latest CI documentation. Enhanced docs.ps1 to automatically update both docfx.links.json with the current LuceneNetVersion during the build process, ensuring navigation and API links always reference the correct version.
…earing inside the apidocs. - Refactor navbar links to use individual properties and moved to the subsite.json. - docfx.links.json and navbar-links.tmpl.partial removed. - docs.ps1 restored as it was originally. - Removed the link json file reference from the metadata docfx.core.json.
…ka26/lucenenet into fix/apidocs-breadcrumb-toc-asf
- Change _navCliHref to absolute URL for published CLI docs - Removed the links jsons globalMetadataFiles leftover and the subsite one was added instead. - Auto-update CLI doc version in docs.ps1 - Improve navbar template indentation for readability and removed a debug message from it.
Contributor
Author
|
Hey @NightOwl888 , @paulirwin! First of all: Sorry this took so long. Some personal stuff came up and I should have communicated earlier. I did keep working on it on and I managed to invent a DocFX issue that did not need to exsist in the first place, and I spent too much time trying to fix it up until I found the actual cause and the current approach works now. The ASF links (and also the navigation links) are now in the docfx metadata. As for the apidocs, they are in the If you want a different structure where these links values are, just let me know and I will adjust it quickly! I just realized that the site was 'left behind' as I was troubleshooting the apidocs, and I will quickly make them more uniform by modify the site to match how the links are stored and called at the navbar partial. Then I will revert it from draft. |
…the apidocs - Replaced array-based navigation link config in docfx.json with individual metadata fields for each link. - Removed the navbar-links.tmpl.partial template as it become no longer necessary. - Updated navbar.tmpl.partial to render links directly from the new fields.
Contributor
Author
|
Now the site and apidocs are more uniform in how the navbar links are stored and rendered. Apologies about the delay again and thanks for your patience! |
1 task
…ined titles; shorten header link text so it all fits
paulirwin
approved these changes
Apr 10, 2026
paulirwin
left a comment
paulirwin
left a comment
Contributor
There was a problem hiding this comment.
Sorry for the delay on this, looks good! I pushed up some small changes to whitespace, a minor accessibility fix, adding in the a tag titles to match the other file in the site project, and shortened the header link text so that it fits without wrapping.
Before:
After:
paulirwin
added
the
notes:website-or-documentation
paulirwin
added a commit
to paulirwin/lucene.net
that referenced
this pull request
Jun 8, 2026
* site: add links to configuration file Introduces _navbarLinks and _asfLinks configuration in docfx.json including the correct event page link. Adds a new navbar-links partial to render these links and updates the main navbar partial to include it. * Fix breadcrumb styles in main.css Now the Api / Libraries works as intended, not splitting into two lines and the slash is restored. * apidocs: add links to configuration file Introduces _navbarLinks and _asfLinks configuration in docfx.global.json including the correct event page link. Adds a new navbar-links partial to render these links and updates the main navbar partial to include it. * apidocs: move links to separate .json - Added docfx.links.json to organize navigation and ASF links separately. It now includes the links. - Modified docfx.site.json to include docfx.links.json in globalMetadataFiles. * Update doc links to use latest Lucene.Net version Added docfx.links.json to metadata and updated navbar links to point to the latest CI documentation. Enhanced docs.ps1 to automatically update both docfx.links.json with the current LuceneNetVersion during the build process, ensuring navigation and API links always reference the correct version. * Fix build error by storing navbar links differently and links not appearing inside the apidocs. - Refactor navbar links to use individual properties and moved to the subsite.json. - docfx.links.json and navbar-links.tmpl.partial removed. - docs.ps1 restored as it was originally. - Removed the link json file reference from the metadata docfx.core.json. * Update CLI doc link with auto-update and minor changes. - Change _navCliHref to absolute URL for published CLI docs - Removed the links jsons globalMetadataFiles leftover and the subsite one was added instead. - Auto-update CLI doc version in docs.ps1 - Improve navbar template indentation for readability and removed a debug message from it. * Refactor navbar config to use individual metadata to be uniform with the apidocs - Replaced array-based navigation link config in docfx.json with individual metadata fields for each link. - Removed the navbar-links.tmpl.partial template as it become no longer necessary. - Updated navbar.tmpl.partial to render links directly from the new fields. * PR feedback: whitespace fixes; a11y improvement for ASF link; use defined titles; shorten header link text so it all fits --------- Co-authored-by: Paul Irwin <paulirwin@gmail.com>
paulirwin
added a commit
to paulirwin/lucene.net
that referenced
this pull request
Jun 16, 2026
* site: add links to configuration file Introduces _navbarLinks and _asfLinks configuration in docfx.json including the correct event page link. Adds a new navbar-links partial to render these links and updates the main navbar partial to include it. * Fix breadcrumb styles in main.css Now the Api / Libraries works as intended, not splitting into two lines and the slash is restored. * apidocs: add links to configuration file Introduces _navbarLinks and _asfLinks configuration in docfx.global.json including the correct event page link. Adds a new navbar-links partial to render these links and updates the main navbar partial to include it. * apidocs: move links to separate .json - Added docfx.links.json to organize navigation and ASF links separately. It now includes the links. - Modified docfx.site.json to include docfx.links.json in globalMetadataFiles. * Update doc links to use latest Lucene.Net version Added docfx.links.json to metadata and updated navbar links to point to the latest CI documentation. Enhanced docs.ps1 to automatically update both docfx.links.json with the current LuceneNetVersion during the build process, ensuring navigation and API links always reference the correct version. * Fix build error by storing navbar links differently and links not appearing inside the apidocs. - Refactor navbar links to use individual properties and moved to the subsite.json. - docfx.links.json and navbar-links.tmpl.partial removed. - docs.ps1 restored as it was originally. - Removed the link json file reference from the metadata docfx.core.json. * Update CLI doc link with auto-update and minor changes. - Change _navCliHref to absolute URL for published CLI docs - Removed the links jsons globalMetadataFiles leftover and the subsite one was added instead. - Auto-update CLI doc version in docs.ps1 - Improve navbar template indentation for readability and removed a debug message from it. * Refactor navbar config to use individual metadata to be uniform with the apidocs - Replaced array-based navigation link config in docfx.json with individual metadata fields for each link. - Removed the navbar-links.tmpl.partial template as it become no longer necessary. - Updated navbar.tmpl.partial to render links directly from the new fields. * PR feedback: whitespace fixes; a11y improvement for ASF link; use defined titles; shorten header link text so it all fits --------- Co-authored-by: Paul Irwin <paulirwin@gmail.com>
This was referenced Jun 23, 2026
This was referenced Jun 27, 2026
Closed
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Render apidocs navbar links via DocFX metadata; fix breadcrumb; fix event link
Fixes #1215 (Continuation of #1198)
Description
api / {subsites}.