Repository navigation
docs: resolve artifact version using existing version metadata - #122
Merged
Merged
Conversation
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
…allation snippets
Replace hardcoded `<version>` placeholders with the `{{artifactVersion}}`
template variable across multiple documentation versions (2.0.0 to 3.0.0).
This allows the documentation engine to dynamically inject the correct
artifact version based on the selected documentation version.
- Update `getting-started.md` and `index.md` for versions 2.0.0, 2.0.1,
2.1.0, 2.2.0, 2.3.0, 2.4.0, and 3.0.0.
- Update `content-artifact-version.test.mjs` to reflect changes in
content structure and verify correct version substitution for older
releases.
This branch was successfully 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
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.
What changed
Wiki Markdown now resolves the exact
{{artifactVersion}}token in the existing content-loading flow:charts_versionfrom the existing snapshot manifest; missing or invalid metadata leaves the token unchanged.3.0.0).{{version}}and{{versionLabel}}substitutions remain unchanged. No separate version resolver infrastructure or manifest changes were introduced.Updated published dependency examples across 2.0.0–3.0.0 to use
{{artifactVersion}}instead of the legacy<version>placeholder:getting-started.mdfor 2.0.0, 2.0.1, 2.1.0, 2.2.0, 2.3.0, 2.4.0, and 3.0.0Historical Maven coordinates and artifact names remain version-specific: 2.x keeps
io.github.dautovicharis, while 3.0.0 usesio.github.hdcharts. Umbrella, modular, platform-specific (where documented), and BOM dependency examples now display their selected release version. Separate<snapshot-version>examples are intentionally unchanged. No unrelated historical documentation was migrated.Testing
npm --prefix docs-app test(24 passed)cd docs-app && npx tsc --noEmitnpm run buildgit diff --checkThe tests read the expected snapshot version from the manifest instead of hardcoding a version and use injected manifest text to cover missing/invalid metadata without modifying the real manifest. They also cover release substitution and historical coordinates.
Manual verification
npm run devfrom the repository root./snapshot/wiki/bar-chartand/snapshot/wiki/getting-started. Confirm dependency examples usecharts_versionfromdocs-app/public/snapshot-manifest.json, including the rendered code and Copy text./3.0.0/wiki/getting-startedand/3.0.0/wiki/ring-gauge-chart. Confirm dependencies display3.0.0, the separate snapshot example keeps<snapshot-version>, and asset links retain the 3.0.0 route./2.4.0/wiki/getting-startedand/2.0.0/wiki/getting-started. Confirm dependency placeholders display their selected versions while preserving historicalio.github.dautovichariscoordinates and any release-specific artifact names.