Add local ApiLink registry snapshots#256
Open
viktorkombov wants to merge 37 commits into
Open
Conversation
ChronosSF
added
status: in-test 💥
ChronosSF
requested changes
Jun 1, 2026
…github.com/IgniteUI/docs-template into vkombov/configure-apilink-index-resolution
![github-advanced-security[bot]](https://avatars.githubusercontent.com/in/57789?s=60&v=4){kind=small}
viktorkombov
changed the title
Strip the `prefixed`, `suffix`, and `exclude` props from every <ApiLink> usage across the documentation MDX sources. These props are now redundant: symbol-name construction (the platform prefix such as Igx/Igc/Igr and the `Component` suffix) and platform applicability are resolved automatically through the API link registry, so the explicit per-tag overrides are no longer needed. Scope (tracked source files only): - docs/xplat/src/content — 94 files - docs/angular/src/content — 224 files Total: 318 MDX files, removing 1321 `prefixed`, 1313 `suffix`, and 19 `exclude` attributes. Only those three attributes were removed. All other props (type, member, label, kind, pkg, ...), tag formatting, and surrounding prose are left untouched — no changes were made outside of <ApiLink> tags.
…props' into aahmedov/strip-apilink-prefixed-suffix-exclude-props # Conflicts: # docs/angular/src/content/en/components/charts/features/chart-overlays.mdx # docs/angular/src/content/en/components/charts/features/chart-performance.mdx # docs/angular/src/content/en/components/excel-library-using-tables.mdx # docs/angular/src/content/en/components/geo-map-type-scatter-contour-series.mdx # docs/angular/src/content/en/components/geo-map-type-scatter-symbol-series.mdx # docs/angular/src/content/en/components/geo-map.mdx # docs/angular/src/content/en/components/inputs/color-editor.mdx # docs/angular/src/content/en/components/linear-gauge.mdx # docs/angular/src/content/en/components/radial-gauge.mdx # docs/angular/src/content/en/components/spreadsheet-chart-adapter.mdx # docs/angular/src/content/en/components/tooltip.mdx # docs/angular/src/content/en/components/zoomslider-overview.mdx # docs/angular/src/content/jp/components/charts/features/chart-axis-layouts.mdx # docs/angular/src/content/jp/components/charts/features/chart-overlays.mdx # docs/angular/src/content/jp/components/charts/features/chart-performance.mdx # docs/angular/src/content/jp/components/excel-library-using-tables.mdx # docs/angular/src/content/jp/components/general/data-analysis.mdx # docs/angular/src/content/jp/components/geo-map-binding-shp-file.mdx # docs/angular/src/content/jp/components/geo-map-type-scatter-symbol-series.mdx # docs/angular/src/content/jp/components/geo-map.mdx # docs/angular/src/content/jp/components/inputs/color-editor.mdx # docs/angular/src/content/jp/components/linear-gauge.mdx # docs/angular/src/content/jp/components/radial-gauge.mdx # docs/angular/src/content/jp/components/spreadsheet-chart-adapter.mdx # docs/angular/src/content/jp/components/spreadsheet-overview.mdx # docs/angular/src/content/jp/components/tooltip.mdx # docs/angular/src/content/jp/components/zoomslider-overview.mdx # docs/xplat/src/content/en/components/bullet-graph.mdx # docs/xplat/src/content/en/components/charts/features/chart-axis-layouts.mdx # docs/xplat/src/content/en/components/charts/features/chart-highlight-filter.mdx # docs/xplat/src/content/en/components/charts/features/chart-tooltips.mdx # docs/xplat/src/content/en/components/general-changelog-dv-blazor.mdx # docs/xplat/src/content/en/components/geo-map-binding-multiple-shapes.mdx # docs/xplat/src/content/en/components/geo-map-binding-shp-file.mdx # docs/xplat/src/content/en/components/geo-map-display-heat-imagery.mdx # docs/xplat/src/content/en/components/geo-map-display-imagery-types.mdx # docs/xplat/src/content/en/components/geo-map-type-scatter-area-series.mdx # docs/xplat/src/content/en/components/geo-map-type-scatter-density-series.mdx # docs/xplat/src/content/en/components/geo-map-type-shape-polygon-series.mdx # docs/xplat/src/content/en/components/geo-map-type-shape-polyline-series.mdx # docs/xplat/src/content/en/components/grid-lite/binding.mdx # docs/xplat/src/content/en/components/grid-lite/cell-template.mdx # docs/xplat/src/content/en/components/grid-lite/column-configuration.mdx # docs/xplat/src/content/en/components/grid-lite/filtering.mdx # docs/xplat/src/content/en/components/grid-lite/header-template.mdx # docs/xplat/src/content/en/components/grid-lite/sorting.mdx # docs/xplat/src/content/en/components/grid-lite/theming.mdx # docs/xplat/src/content/en/components/grids/pivot-grid/overview.mdx # docs/xplat/src/content/jp/components/bullet-graph.mdx # docs/xplat/src/content/jp/components/charts/features/chart-tooltips.mdx # docs/xplat/src/content/jp/components/general-changelog-dv-blazor.mdx # docs/xplat/src/content/jp/components/geo-map-binding-multiple-shapes.mdx # docs/xplat/src/content/jp/components/geo-map-display-heat-imagery.mdx # docs/xplat/src/content/jp/components/geo-map-shape-files-reference.mdx # docs/xplat/src/content/jp/components/geo-map-type-scatter-area-series.mdx # docs/xplat/src/content/jp/components/geo-map-type-scatter-bubble-series.mdx # docs/xplat/src/content/jp/components/geo-map-type-scatter-contour-series.mdx # docs/xplat/src/content/jp/components/geo-map-type-scatter-density-series.mdx # docs/xplat/src/content/jp/components/geo-map-type-shape-polygon-series.mdx # docs/xplat/src/content/jp/components/geo-map-type-shape-polyline-series.mdx # docs/xplat/src/content/jp/components/grid-lite/binding.mdx # docs/xplat/src/content/jp/components/grid-lite/cell-template.mdx # docs/xplat/src/content/jp/components/grid-lite/column-configuration.mdx # docs/xplat/src/content/jp/components/grid-lite/filtering.mdx # docs/xplat/src/content/jp/components/grid-lite/header-template.mdx # docs/xplat/src/content/jp/components/grid-lite/sorting.mdx # docs/xplat/src/content/jp/components/grid-lite/theming.mdx # docs/xplat/src/content/jp/components/grids/_shared/column-types.mdx # docs/xplat/src/content/jp/components/grids/_shared/editing.mdx # docs/xplat/src/content/jp/components/grids/_shared/filtering.mdx # docs/xplat/src/content/jp/components/grids/_shared/keyboard-navigation.mdx # docs/xplat/src/content/jp/components/grids/_shared/row-selection.mdx # docs/xplat/src/content/jp/components/grids/_shared/virtualization.mdx # docs/xplat/src/content/jp/components/grids/pivot-grid/overview.mdx # docs/xplat/src/content/jp/components/menus/toolbar.mdx
…rip-apilink-prefixed-suffix-exclude-props # Conflicts: # docs/xplat/src/content/en/components/excel-library-using-tables.mdx # docs/xplat/src/content/en/components/general-changelog-dv-react.mdx # docs/xplat/src/content/en/components/general-changelog-dv-wc.mdx # docs/xplat/src/content/en/components/grids/_shared/advanced-filtering.mdx # docs/xplat/src/content/en/components/grids/_shared/batch-editing.mdx # docs/xplat/src/content/en/components/grids/_shared/cascading-combos.mdx # docs/xplat/src/content/en/components/grids/_shared/cell-editing.mdx # docs/xplat/src/content/en/components/grids/_shared/cell-merging.mdx # docs/xplat/src/content/en/components/grids/_shared/cell-selection.mdx # docs/xplat/src/content/en/components/grids/_shared/clipboard-interactions.mdx # docs/xplat/src/content/en/components/grids/_shared/collapsible-column-groups.mdx # docs/xplat/src/content/en/components/grids/_shared/column-hiding.mdx # docs/xplat/src/content/en/components/grids/_shared/column-moving.mdx # docs/xplat/src/content/en/components/grids/_shared/column-pinning.mdx # docs/xplat/src/content/en/components/grids/_shared/column-resizing.mdx # docs/xplat/src/content/en/components/grids/_shared/column-selection.mdx # docs/xplat/src/content/en/components/grids/_shared/column-types.mdx # docs/xplat/src/content/en/components/grids/_shared/conditional-cell-styling.mdx # docs/xplat/src/content/en/components/grids/_shared/editing.mdx # docs/xplat/src/content/en/components/grids/_shared/excel-style-filtering.mdx # docs/xplat/src/content/en/components/grids/_shared/export-excel.mdx # docs/xplat/src/content/en/components/grids/_shared/filtering.mdx # docs/xplat/src/content/en/components/grids/_shared/keyboard-navigation.mdx # docs/xplat/src/content/en/components/grids/_shared/live-data.mdx # docs/xplat/src/content/en/components/grids/_shared/multi-column-headers.mdx # docs/xplat/src/content/en/components/grids/_shared/multi-row-layout.mdx # docs/xplat/src/content/en/components/grids/_shared/paging.mdx # docs/xplat/src/content/en/components/grids/_shared/remote-data-operations.mdx # docs/xplat/src/content/en/components/grids/_shared/row-actions.mdx # docs/xplat/src/content/en/components/grids/_shared/row-adding.mdx # docs/xplat/src/content/en/components/grids/_shared/row-drag.mdx # docs/xplat/src/content/en/components/grids/_shared/row-editing.mdx # docs/xplat/src/content/en/components/grids/_shared/row-pinning.mdx # docs/xplat/src/content/en/components/grids/_shared/row-selection.mdx # docs/xplat/src/content/en/components/grids/_shared/search.mdx # docs/xplat/src/content/en/components/grids/_shared/selection.mdx # docs/xplat/src/content/en/components/grids/_shared/size.mdx # docs/xplat/src/content/en/components/grids/_shared/sizing.mdx # docs/xplat/src/content/en/components/grids/_shared/sorting.mdx # docs/xplat/src/content/en/components/grids/_shared/state-persistence.mdx # docs/xplat/src/content/en/components/grids/_shared/summaries.mdx # docs/xplat/src/content/en/components/grids/_shared/toolbar.mdx # docs/xplat/src/content/en/components/grids/_shared/validation.mdx # docs/xplat/src/content/en/components/grids/_shared/virtualization.mdx # docs/xplat/src/content/en/components/grids/grid/groupby.mdx # docs/xplat/src/content/en/components/grids/grid/selection-based-aggregates.mdx # docs/xplat/src/content/en/components/layouts/splitter.mdx # docs/xplat/src/content/en/components/spreadsheet-chart-adapter.mdx # docs/xplat/src/content/jp/components/excel-library-using-tables.mdx # docs/xplat/src/content/jp/components/grids/_shared/advanced-filtering.mdx # docs/xplat/src/content/jp/components/grids/_shared/batch-editing.mdx # docs/xplat/src/content/jp/components/grids/_shared/cascading-combos.mdx # docs/xplat/src/content/jp/components/grids/_shared/cell-editing.mdx # docs/xplat/src/content/jp/components/grids/_shared/cell-selection.mdx # docs/xplat/src/content/jp/components/grids/_shared/clipboard-interactions.mdx # docs/xplat/src/content/jp/components/grids/_shared/collapsible-column-groups.mdx # docs/xplat/src/content/jp/components/grids/_shared/column-hiding.mdx # docs/xplat/src/content/jp/components/grids/_shared/column-moving.mdx # docs/xplat/src/content/jp/components/grids/_shared/column-pinning.mdx # docs/xplat/src/content/jp/components/grids/_shared/column-resizing.mdx # docs/xplat/src/content/jp/components/grids/_shared/column-selection.mdx # docs/xplat/src/content/jp/components/grids/_shared/conditional-cell-styling.mdx # docs/xplat/src/content/jp/components/grids/_shared/excel-style-filtering.mdx # docs/xplat/src/content/jp/components/grids/_shared/export-excel.mdx # docs/xplat/src/content/jp/components/grids/_shared/live-data.mdx # docs/xplat/src/content/jp/components/grids/_shared/multi-column-headers.mdx # docs/xplat/src/content/jp/components/grids/_shared/multi-row-layout.mdx # docs/xplat/src/content/jp/components/grids/_shared/paging.mdx # docs/xplat/src/content/jp/components/grids/_shared/remote-data-operations.mdx # docs/xplat/src/content/jp/components/grids/_shared/row-actions.mdx # docs/xplat/src/content/jp/components/grids/_shared/row-adding.mdx # docs/xplat/src/content/jp/components/grids/_shared/row-drag.mdx # docs/xplat/src/content/jp/components/grids/_shared/row-editing.mdx # docs/xplat/src/content/jp/components/grids/_shared/row-pinning.mdx # docs/xplat/src/content/jp/components/grids/_shared/search.mdx # docs/xplat/src/content/jp/components/grids/_shared/selection.mdx # docs/xplat/src/content/jp/components/grids/_shared/size.mdx # docs/xplat/src/content/jp/components/grids/_shared/sizing.mdx # docs/xplat/src/content/jp/components/grids/_shared/sorting.mdx # docs/xplat/src/content/jp/components/grids/_shared/state-persistence.mdx # docs/xplat/src/content/jp/components/grids/_shared/summaries.mdx # docs/xplat/src/content/jp/components/grids/_shared/toolbar.mdx # docs/xplat/src/content/jp/components/grids/_shared/validation.mdx # docs/xplat/src/content/jp/components/grids/grid/groupby.mdx # docs/xplat/src/content/jp/components/grids/grid/selection-based-aggregates.mdx # docs/xplat/src/content/jp/components/spreadsheet-chart-adapter.mdx
…-suffix-exclude-props Remove prefixed, suffix, and exclude props from ApiLink components
…-props Remove Api Links props and add missing links from igniteui-xplat-docs
…to vkombov/configure-apilink-index-resolution
…ripts for content regeneration
…member matching logic
- Removed `pkg="grids"` from ApiLink components in summaries, toolbar, validation, virtualization, and dropdown documentation. - Adjusted references in groupby and selection-based aggregates documentation to streamline ApiLink usage. - Enhanced clarity in descriptions related to component functionalities and properties.
- Introduced new markdown reports for API link checks in React and Web Components. - Enhanced the link checking script to support ambiguity detection and reporting. - Added functionality to filter and exclude specific TOC slugs based on platform. - Improved error handling and reporting for ambiguous API links. - Updated the script to generate platform-specific MDX content before scanning.
…caping or encoding' Co-authored-by: Copilot Autofix powered by AI <62310815+github-advanced-security[bot]@users.noreply.github.com>
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
5 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.
Closes #49
Closes #283
Summary
Adds local latest ApiLink registry snapshots and wires platform context to provide them to ApiLink during docs builds.
Changes
src/data/api-link-index/.staging-latestorprod-latestregistry data based on build environment.webcomponentsas the public/local Web Components registry folder.Testing
webcomponents/staging-latest.json.