Repository navigation
Share one ApiLink component across partials - #489
Open
eugenia-scandit wants to merge 1 commit into
Open
eugenia-scandit wants to merge 1 commit into
eugenia-scandit wants to merge 1 commit into
Conversation
Six partials built API-reference links by hand: five pasted the same inline ApiLink, and the MatrixScan Pick intro built one link itself. They now import src/components/ApiLink. The freeze rewrite in scripts/update-version.py repoints a snapshot's API links by replacing URL text, which a link built in code never contains. So docusaurus.config.ts publishes apiReferencePrefixByVersion by the version's role, the same rule the rewrite applies: the current version links the unversioned API reference, a frozen version its own <major>.<minor> line. - The API-reference path segment for each framework (dotnet.ios, or none for Linux, Titanium and hosted) is a required field in the framework registry. - An unknown framework name, or a docs version with no prefix, fails the build instead of rendering a wrong or missing link. - test:api-link covers the URL builder and fails if a doc builds its own API-reference link again. It runs in CI. The 48 pages that use these partials render the same 765 API links as the live site, and a temporary page in the 7.6.15 snapshot linked /7.6/. Co-Authored-By: Claude Opus 5.5 (1M context) <noreply@anthropic.com>
|
This branch has not been deployed
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
1 participant
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.
Six partials built API-reference links by hand: five pasted the same inline ApiLink, and the MatrixScan Pick intro built one link itself. They now import src/components/ApiLink.
The freeze rewrite in scripts/update-version.py repoints a snapshot's API links by replacing URL text, which a link built in code never contains. So docusaurus.config.ts publishes apiReferencePrefixByVersion by the version's role, the same rule the rewrite applies: the current version links the unversioned API reference, a frozen version its own . line.
The 48 pages that use these partials render the same 765 API links as the live site, and a temporary page in the 7.6.15 snapshot linked /7.6/.