Skip to content

DOP-5509: offline composable tutorials #1474

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

Merged
merged 12 commits into from
Jul 2, 2025
Merged

DOP-5509: offline composable tutorials #1474

merged 12 commits into from
Jul 2, 2025

Conversation

seungpark
Copy link
Collaborator

@seungpark seungpark commented Jun 30, 2025

Stories/Links:

DOP-5509

Staging Links:

Offline doc is uploaded to S3 here. Download the file and open the page for an example of a composable tutorial that works offline

Staging link with env var OFFLINE_DOCS=false for regression checks for online docs

Notes:

  • Offline docs do not take advantage of local storage or URL query params - this logic is strictly baked into the elements and their props
  • Composable tutorials are meant to have one per page - the staging link above shows an erroneous usage of multiple - these will not behave as one, but as independent selectors

README updates

    • This PR introduces changes that should be reflected in the README, and I have made those updates.
    • This PR does not introduce changes that should be reflected in the README

Copy link

netlify bot commented Jun 30, 2025

Deploy Preview for docs-frontend-stg ready!

Name Link
🔨 Latest commit 108350b
🔍 Latest deploy log https://app.netlify.com/projects/docs-frontend-stg/deploys/68653825f5c51e00089c819b
😎 Deploy Preview https://deploy-preview-1474--docs-frontend-stg.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify project configuration.

@docs-builder-bot
Copy link

docs-builder-bot commented Jun 30, 2025

🔄 Deploy Preview for docs-frontend-stg processing

Item Details
🔨 Latest Commit a597c68124ea6e0eab820ea8798be124f3a695e7
😎 Deploy Preview https://deploy-preview-1474--docs-frontend-stg.netlify.app
🔍 Build Logs View Logs

@seungpark seungpark requested review from mmeigs and rayangler June 30, 2025 16:14
@seungpark seungpark marked this pull request as ready for review June 30, 2025 16:14
return (
<div className={cx(offlineMenuStyling, 'offline-select-menu')}>
<div
className={cx(offlineMenuStyling, className ? className : 'offline-select-menu')}
Copy link
Collaborator

Choose a reason for hiding this comment

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

nit: Could use nullish coalescer className ?? 'offline-select-menu'

Copy link
Collaborator

Choose a reason for hiding this comment

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

(Also nit) Alternatively, I don't think they need to be mutually exclusive, but this might depend on use case.

className={cx(offlineMenuStyling, 'offline-select-menu', className)}

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

done! great callouts

return (
<div className={cx(offlineMenuStyling, 'offline-select-menu')}>
<div
className={cx(offlineMenuStyling, className ? className : 'offline-select-menu')}
Copy link
Collaborator

Choose a reason for hiding this comment

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

(Also nit) Alternatively, I don't think they need to be mutually exclusive, but this might depend on use case.

className={cx(offlineMenuStyling, 'offline-select-menu', className)}

@seungpark
Copy link
Collaborator Author

the staging links above have been updated with the latest commits! thank you for the great comments! PTAL

@seungpark seungpark requested review from mmeigs and rayangler July 1, 2025 21:47
Copy link
Collaborator

@mmeigs mmeigs left a comment

Choose a reason for hiding this comment

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

Thank you!! Changes look great.

@seungpark seungpark merged commit 99b5cf4 into main Jul 2, 2025
6 checks passed
@seungpark seungpark deleted the DOP-5509 branch July 2, 2025 16:03
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants