[dg] Render dg docs within the app #29233
Merged
Conversation
This file contains 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
|
Deploy preview for dagit-core-storybook ready! ✅ Preview Built with commit a355547. |
hellendag
force-pushed
the
dish/build-938-dg-in-app
branch
from
dd4c9ed to
5851e7b
Compare
salazarm
approved these changes
Apr 11, 2025
hellendag
commented
Apr 11, 2025
| transpilePackages: [ | ||
| '@dagster-io/ui-components', | ||
| '@dagster-io/ui-core', | ||
| '@dagster-io/dg-docs-components', |
There was a problem hiding this comment.
This package must be transpiled by app-oss Next.js config like the others, because it's a local workspace package.
|
|
||
| if (!contents) { | ||
| return <div className={styles.emptyState}>No components found.</div>; | ||
| } |
There was a problem hiding this comment.
We should iterate on the empty states. cc @katefarrar
| background-color: var(--color-background-light-hover); | ||
| color: var(--color-text-default); | ||
| text-decoration: none; | ||
| } |
There was a problem hiding this comment.
These are mostly copied over from existing CSS files in dg-docs-site, now moved to dg-docs-components so they can be used in the main app.
hellendag
force-pushed
the
dish/build-938-dg-in-app
branch
from
5851e7b to
a355547
Compare
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.
Summary & Motivation
Behind a feature flag, render
dg docswithin the app, within code locations that have docs available.This involved some changes to the existing
dg-docs-siteto reuse some pieces that are currently there but are reusable here.Brief demo:
Screen.Recording.2025-04-11.at.15.14.08.mov
Ignore the
defaultcursor on there -- the cursors are correct, this is just QuickTime Player acting up.How I Tested These Changes
dg devin dg-enabled project, then run JS dev for Dagster app.Run
dg docs serve, verify that this continues to build and render correctly.