Skip to content
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

Update the website to document the end-to-end lifecycle of Compiled #1738

Merged
merged 4 commits into from
Oct 30, 2024

Conversation

kylorhall-atlassian
Copy link
Collaborator

What is this change?

I'm updating the documentation on https://compiledcssinjs.com from internal feedback around the Compiled work as people are questioning and need to understand the differences between runtime and extraction.

Very open to feedback! It just seemed like the content on the homepage was quite important, but even I've never read it! Moving it to /docs/how-it-works might help that.

I did remove a few scenarios around dynamic styles, eg. the style={{ '--abcde': props.color }} pattern, but I think it's documented elsewhere and it's best to keep it simple.


PR checklist

  • Updated the documentation in website/

Copy link

changeset-bot bot commented Oct 30, 2024

⚠️ No Changeset found

Latest commit: 382b508

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

Copy link

netlify bot commented Oct 30, 2024

Deploy Preview for compiled-css-in-js ready!

Name Link
🔨 Latest commit 382b508
🔍 Latest deploy log https://app.netlify.com/sites/compiled-css-in-js/deploys/6722b8c166754e0007b07ddb
😎 Deploy Preview https://deploy-preview-1738--compiled-css-in-js.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 site configuration.

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

This file was used on https://compiledcssinjs.com/docs/api-css-prop, I feel it was fine to update it to be a bit more succinct and share it elsewhere.

@@ -1,105 +1,36 @@
import { ExampleContainer, ExampleRoot } from '@compiled/website-ui';
import { LargeText } from '../components/example';

## Don't change a thing
Copy link
Collaborator Author

Choose a reason for hiding this comment

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

We do kinda want people to change a few things now 😄

liamqma
liamqma previously approved these changes Oct 30, 2024
@liamqma
Copy link
Collaborator

liamqma commented Oct 30, 2024

Thanks @kylorhall-atlassian!

@kylorhall-atlassian kylorhall-atlassian merged commit 18d2529 into master Oct 30, 2024
13 checks passed
@kylorhall-atlassian kylorhall-atlassian deleted the kylorhall/move-how-it-works branch October 30, 2024 23:09
@alexreardon alexreardon self-requested a review October 31, 2024 03:30
@alexreardon
Copy link
Contributor

A bit late - but I approve! This is a wonderful change. I've messaged you some opportunities to further build on the great work you have done 🫡

Copy link
Contributor

@alexreardon alexreardon left a comment

Choose a reason for hiding this comment

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

Looks good!

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