Skip to content

docs: show ng-add schema files in schematics-for-libraries guide#69691

Open
franmc01 wants to merge 1 commit into
angular:mainfrom
franmc01:docs-schematics-ng-add-schema
Open

docs: show ng-add schema files in schematics-for-libraries guide#69691
franmc01 wants to merge 1 commit into
angular:mainfrom
franmc01:docs-schematics-ng-add-schema

Conversation

@franmc01

@franmc01 franmc01 commented Jul 8, 2026

Copy link
Copy Markdown
Contributor

PR Checklist

PR Type

  • Bugfix
  • Feature
  • Code style update (formatting, local variables)
  • Refactoring (no functional changes, no api changes)
  • Build related changes
  • CI related changes
  • Documentation content changes
  • angular.dev application / infrastructure changes
  • Other... Please describe:

What is the current behavior?

In the "Schematics for libraries" guide, the ng add walkthrough references two files it never shows: the collection (collection.1.json) points to ng-add/schema.json, and ng-add/index.ts imports its Schema interface from ng-add/schema.ts. A reader following the walkthrough hits both references with no definition.

Issue Number: #57005

What is the new behavior?

  • The "Providing installation support" section now shows ng-add/schema.json and ng-add/schema.ts, mirroring the "Providing generation support" section that already shows the equivalent files for my-service.
  • Both files already exist in the guide's example project; this only surfaces them with <docs-code> blocks. No prose rewrite and no example-code changes.

Does this PR introduce a breaking change?

  • Yes
  • No

Other information

Fixes #57005

The ng-add walkthrough references two files it never shows: the
collection points to `ng-add/schema.json` and `index.ts` imports its
`Schema` interface from `ng-add/schema.ts`. Add the missing code blocks,
mirroring the generation-support section, so the example is complete.

Fixes angular#57005
@pullapprove pullapprove Bot requested a review from MarkTechson July 8, 2026 21:26
@angular-robot angular-robot Bot added the area: docs Related to the documentation label Jul 8, 2026
@ngbot ngbot Bot added this to the Backlog milestone Jul 8, 2026
@JeanMeche JeanMeche requested review from alan-agius4 and removed request for MarkTechson July 8, 2026 21:31
@github-actions

github-actions Bot commented Jul 9, 2026

Copy link
Copy Markdown

Deployed adev-preview for 06344cf to: https://ng-dev-previews-fw--pr-angular-angular-69691-adev-prev-ajrqwoma.web.app

Note: As new commits are pushed to this pull request, this link is updated after the preview is rebuilt.

@alan-agius4 alan-agius4 left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM, thanks

@alan-agius4 alan-agius4 added action: merge The PR is ready for merge by the caretaker target: patch This PR is targeted for the next patch release labels Jul 9, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

action: merge The PR is ready for merge by the caretaker adev: preview area: docs Related to the documentation target: patch This PR is targeted for the next patch release

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Missing documentation/files about ng-add schematic for libraries

2 participants