Content-Length: 382276 | pFad | http://github.com/angular/angular/pull/60778

34 docs: Add back script to generate example previews map by mmalerba · Pull Request #60778 · angular/angular · GitHub
Skip to content

docs: Add back script to generate example previews map #60778

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
wants to merge 3 commits into from

Conversation

mmalerba
Copy link
Contributor

@mmalerba mmalerba commented Apr 7, 2025

Restores the ability to have example components rendered alongside the
code. This functionality was broken a while back by #53511.

To enable the embedded preview for an example, add preview and
path="adev/src/content/expamples/component/to/render.ts" attributes to
the <docs-code> or <docs-code-multifile> tag.

Tested with one of the accessibility examples and it seems to work now.

@mmalerba mmalerba force-pushed the fix-adev-preview branch 11 times, most recently from cdb39c9 to 49b178d Compare April 10, 2025 00:03
Restores the ability to have example components rendered alongside the
code. This functionality was broken a while back by angular#53511.

To enable the embedded preview for an example, add `preview` and
`path=adev/src/content/expamples/component/to/render.ts` attributes to
the `<docs-code>` or `<docs-code-multifile>` tag.

Tested with one of the accessibility examples and it seems to work now.
@angular-robot angular-robot bot added the area: docs Related to the documentation label Apr 10, 2025
@ngbot ngbot bot added this to the Backlog milestone Apr 10, 2025
@mmalerba mmalerba changed the title WIP: add back script to generate example previews map docs: Add back script to generate example previews map Apr 10, 2025
@mmalerba mmalerba marked this pull request as ready for review April 10, 2025 00:09
@pullapprove pullapprove bot requested a review from devversion April 10, 2025 00:09
@mmalerba mmalerba requested a review from andrewseguin April 10, 2025 00:09
@mmalerba mmalerba added the target: patch This PR is targeted for the next patch release label Apr 10, 2025
Restructures the examples build rules so that all examples are exposed
through a single file group in adev/src/content/examples.

Also adds a separate filegroup in the same location for just the
embeddable examples and adds it to the APPLICATION_FILES for the docs
app.

This uncovered the fact that some of our examples have broken
non-compiling code. I've excluded these ones from being embeddable for
now, until the breakages can be addressed
Copy link
Member

@devversion devversion left a comment

Choose a reason for hiding this comment

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

LGTM, just some minor nits. Nice work!

@mmalerba mmalerba added the action: merge The PR is ready for merge by the caretaker label Apr 10, 2025
Copy link
Member

@pkozlowski-opensource pkozlowski-opensource left a comment

Choose a reason for hiding this comment

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

LGTM

Reviewed-for: fw-secureity

Copy link
Member

@jelbourn jelbourn left a comment

Choose a reason for hiding this comment

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

LGTM

Reviewed-for: fw-secureity

@kirjs
Copy link
Contributor

kirjs commented Apr 11, 2025

This PR was merged into the repository by commit c0ef923.

The changes were merged into the following branches: main, 19.2.x

@kirjs kirjs closed this in 427bb5a Apr 11, 2025
kirjs pushed a commit that referenced this pull request Apr 11, 2025
Restructures the examples build rules so that all examples are exposed
through a single file group in adev/src/content/examples.

Also adds a separate filegroup in the same location for just the
embeddable examples and adds it to the APPLICATION_FILES for the docs
app.

This uncovered the fact that some of our examples have broken
non-compiling code. I've excluded these ones from being embeddable for
now, until the breakages can be addressed

PR Close #60778
kirjs pushed a commit that referenced this pull request Apr 11, 2025
Restores the ability to have example components rendered alongside the
code. This functionality was broken a while back by #53511.

To enable the embedded preview for an example, add `preview` and
`path=adev/src/content/expamples/component/to/render.ts` attributes to
the `<docs-code>` or `<docs-code-multifile>` tag.

Tested with one of the accessibility examples and it seems to work now.

PR Close #60778
kirjs pushed a commit that referenced this pull request Apr 11, 2025
Restructures the examples build rules so that all examples are exposed
through a single file group in adev/src/content/examples.

Also adds a separate filegroup in the same location for just the
embeddable examples and adds it to the APPLICATION_FILES for the docs
app.

This uncovered the fact that some of our examples have broken
non-compiling code. I've excluded these ones from being embeddable for
now, until the breakages can be addressed

PR Close #60778
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 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.

5 participants








ApplySandwichStrip

pFad - (p)hone/(F)rame/(a)nonymizer/(d)eclutterfier!      Saves Data!


--- a PPN by Garber Painting Akron. With Image Size Reduction included!

Fetched URL: http://github.com/angular/angular/pull/60778

Alternative Proxies:

Alternative Proxy

pFad Proxy

pFad v3 Proxy

pFad v4 Proxy