Skip to content

Conversation

@twjeffery
Copy link
Collaborator

A first spike on using our githhub backlog to populate the content on the component and examples page on the design system website.

I redid the AllComponents page using github to populate the content.

This should be visually and functionally the same as https://design.alberta.ca/components, but now all of the content is pulled from Design System

@netlify
Copy link

netlify bot commented May 13, 2025

Deploy Preview for abgov-ui-component-docs ready!

Name Link
🔨 Latest commit 9bda0fe
🔍 Latest deploy log https://app.netlify.com/projects/abgov-ui-component-docs/deploys/68757fc90825d80008b6efef
😎 Deploy Preview https://deploy-preview-365--abgov-ui-component-docs.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.

@twjeffery twjeffery requested a review from bdfranck May 13, 2025 21:12
@twjeffery twjeffery marked this pull request as ready for review May 13, 2025 21:12
@twjeffery twjeffery linked an issue May 13, 2025 that may be closed by this pull request
@bdfranck bdfranck force-pushed the thomasjeffery/examples-page branch from efd373c to 57337c2 Compare May 14, 2025 15:18
@bdfranck bdfranck force-pushed the thomasjeffery/examples-page branch from 57337c2 to 68ae5c6 Compare May 14, 2025 15:21
@ArakTaiRoth
Copy link
Collaborator

@twjeffery @bdfranck I think one thing to look at when testing this, is load times. We might be able to add caching which would help significantly, but we'd need a way to verify when the cache needs to be updated. For now though, load times might be an issue.

@twjeffery
Copy link
Collaborator Author

@twjeffery @bdfranck I think one thing to look at when testing this, is load times. We might be able to add caching which would help significantly, but we'd need a way to verify when the cache needs to be updated. For now though, load times might be an issue.

Good point Dustin. I created this sub-issue after some initial exploration: GovAlta/ui-components#2725

I don't think we should start this until we finalize the example pages and the graphQL needs so that we don't have to keep updating it.

@twjeffery twjeffery changed the title feat(#2715): spike pull information from github feat(#2715): Add examples section that is integrated with Github May 23, 2025
@twjeffery twjeffery force-pushed the thomasjeffery/examples-page branch from 63aa41f to 67f990d Compare May 30, 2025 01:58
bdfranck

This comment was marked as duplicate.

Copy link
Collaborator

@bdfranck bdfranck left a comment

Choose a reason for hiding this comment

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

I looked at the deploy preview...

  • ✅ The example page loads with only three requests to GitHub's GraphQL server
  • ✅ The GraphQL data is cached in the browser's localstorage
  • ✅ The cached data has an expiry
  • ✅ The expiry time is 24 hours in the future
  • ✅ All the published examples have thumbnails

Looks good to me! 👍

@twjeffery twjeffery merged commit 8feae26 into alpha Jul 16, 2025
7 checks passed
@twjeffery twjeffery deleted the thomasjeffery/examples-page branch July 16, 2025 19:05
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

4 participants