Skip to content

Fix/apidocs breadcrumb toc asf#1232

Open
zka26 wants to merge 10 commits intoapache:masterfrom
zka26:fix/apidocs-breadcrumb-toc-asf
Open

Fix/apidocs breadcrumb toc asf#1232
zka26 wants to merge 10 commits intoapache:masterfrom
zka26:fix/apidocs-breadcrumb-toc-asf

Conversation

@zka26
Copy link
Contributor

@zka26 zka26 commented Jan 11, 2026

  • You've read the Contributor Guide and Code of Conduct.
  • You've included unit or integration tests for your change, where applicable.
  • You've included inline docs for your change, where applicable.
  • There's an open issue for the PR that you are making. If you'd like to propose a change, please open an issue to discuss the change or find an existing issue.

Render apidocs navbar links via DocFX metadata; fix breadcrumb; fix event link

Fixes #1215 (Continuation of #1198)

Description

  • Fixed breadcrumb rendering: the breadcrumb is no longer split across multiple lines and is displayed as a single line with / separators.
  • Updated the ASF “Events” link: adjusted it so it matches the regex.
  • Improved navbar rendering for site + apidocs: ASF menu is emitted as static HTML during DocFX build on both the main site and apidocs.
  • Now the ASF dropdown menu appears in the api / {subsites}.
Képernyőkép 2026-01-11 221609

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.
- 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.
@zka26 zka26 marked this pull request as draft January 11, 2026 22:06
@zka26
Copy link
Contributor Author

zka26 commented Jan 11, 2026

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 docfx.global.subsites.json and I added it docfx.site.json's globalMetadataFiles so it appears everywhere, both the main page and the /api pages and it is updated only at one place. (Added auto-update to the docs.ps1)

If you want a different structure where these links values are, just let me know and I will adjust it quickly!
Also, I left the exsisting JS-based runtime injection, I did not notice any issue, but let me know if you want anything about that.

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.
@zka26 zka26 marked this pull request as ready for review January 11, 2026 23:10
@zka26
Copy link
Contributor Author

zka26 commented Jan 11, 2026

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!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Website caching issue

1 participant