Remove xplat-generated topics from the Angular source#410
Open
Zneeky wants to merge 2 commits into
Open
Conversation
… source
The Angular build compiles the shared xplat docs and copies them over
docs/angular/src/content/{en,jp}/ on every build (sync-generated.mjs),
overwriting everything except grids/, changelog/, and toc.json. The
committed copies of those topics were stale snapshots — editing them had
no effect because the build regenerates them from docs/xplat/src/content/.
Remove the 208 overridden topic files (104 en + 104 jp) from the Angular
source and ignore the regenerated output via an "xplat-generated topics"
block in each locale's .gitignore, so they can't reappear as untracked
files or be re-committed. Document the behavior in the root CONTRIBUTING
and README.
Verified: Angular en/jp builds are byte-identical before and after (only
non-deterministic build artifacts differ), the content tree stays clean
after a build, and check:llms-metadata passes.
Contributor
There was a problem hiding this comment.
Pull request overview
This PR removes xplat-generated Data Visualization (and related cross-platform) topic files that were previously committed under docs/angular/src/content/{en,jp}/components/, since they are overwritten during Angular builds by docs/angular/scripts/sync-generated.mjs. It also adds locale-level ignore rules and documentation so the generated copies don’t get recommitted and contributors edit the xplat sources instead.
Changes:
- Deleted large sets of xplat-overwritten Angular topic files under
docs/angular/src/content/{en,jp}/components/. - Added
.gitignorerules in the Angularenandjpcontent roots to ignore the build-regenerated topic groups. - Documented the Angular/xplat generation + ownership model in
README.mdand.github/CONTRIBUTING.md.
Reviewed changes
Copilot reviewed 113 out of 212 changed files in this pull request and generated 1 comment.
Show a summary per file
| File | Description |
|---|---|
| README.md | Clarifies that some Angular content is generated from xplat at build time and should not be edited/committed in docs/angular/. |
| .github/CONTRIBUTING.md | Documents the Angular build sync behavior and points contributors to edit xplat sources + keep ignore rules updated. |
| docs/angular/src/content/en/.gitignore | Ignores xplat-generated topic groups copied into the Angular EN tree during builds. |
| docs/angular/src/content/jp/.gitignore | Ignores xplat-generated topic groups copied into the Angular JP tree during builds. |
| docs/angular/src/content/{en,jp}/components/** (many files) | Removes committed snapshots of topics that are regenerated from xplat and overwritten on every build. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
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.
Closes #401
What & why
A number of Data-Visualization / cross-platform topics under
docs/angular/src/content/{en,jp}/components/were committed to the Angular source but are overwritten on every build. The Angular build runsdocs/angular/scripts/sync-generated.mjs(viasync:generated-from-xplat) beforeastro build, which compiles the shared xplat docs and copies them over the Angular content tree - everything exceptgrids/,changelog/, andtoc.json.So those committed files were stale snapshots: editing them under
docs/angular/had no effect, since the build regenerates them fromdocs/xplat/src/content/. This PR removes them so it's clear they're xplat-owned, and prevents them from silently coming back.Changes
en+ 104jp) fromdocs/angular/src/content/{en,jp}/components/:charts/**(except the Angular-ownedcharts/features/chart-legends.mdx),geo-map*, gauges (bullet-graph,linear-gauge,radial-gauge),zoomslider-overview,dashboard-tile,spreadsheet-*,excel-library*/excel-utility,general-changelog-dv,inputs/color-editor,interactivity/accessibility-compliance,maps/map-api,menus/toolbar.xplat-generated topicsglob block todocs/angular/src/content/en/.gitignoreand.../jp/.gitignore(appended below the existinggenerate-grids.mjsrules, which are preserved), so the build-regenerated copies are ignored instead of showing as untracked noise / being re-committed..github/CONTRIBUTING.md(section "Updating of Data Visualization related topics") and rootREADME.md("Content Locations").Left untouched (Angular-owned):
grids/**,changelog/**,toc.json,ai/**, pure-Angular component topics, and the entirekrlocale (no xplat source).No regression - how it was verified
dist/angular(en) before and after the change and diffed. All differing HTML reduced to non-deterministic build artifacts only - auto-generatedigd-table-NIDs (which shift even on Angular-owned pages that weren't touched, e.g.calendar,grid/master-detail), the sitemap<lastmod>timestamp, and pagefind/astro manifests.enandjpbuilds succeed and leavegit statusclean - every removed file is regenerated and ignored, nothing leaks..gitignorepatterns (0 uncovered), Angular-owned topics stay visible, andgenerate-grids.mjsoutput stays ignored.npm run check:llms-metadatapasses (the same content is still validated viadocs/xplat/src/content/).Reviewer notes
sync-generated.mjs) is unchanged - this PR only removes source files and adds ignore rules + docs.components/charts/is ignored wholesale; the one Angular-owned file in it (charts/features/chart-legends.mdx) stays tracked (a.gitignorerule never untracks an already-tracked file).docs/xplat/src/content/, add a matching pattern to the two.gitignoreblocks (documented in CONTRIBUTING).