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 most of Compiled documentation to reflect current recommendations #1688

Merged
merged 6 commits into from
Jul 12, 2024

Conversation

dddlr
Copy link
Collaborator

@dddlr dddlr commented Jul 12, 2024

Follow-up to #1687

Update most of the Compiled documentation so that it matches our current recommendations (e.g. object styles > template strings) and the UI Styling Standard recommendations.

Sections changed as part of this PR:

Screenshot 2024-07-12 at 11 29 30

See the individual commits for a detailed breakdown of changes - reading commit-by commit will likely be far easier to review. Summary of most notable commits:

  • Update 'Writing CSS' and 'Installation', move some sections into new 'Deprecated features' section
  • Update CSS prop page and deprecated syntax page:
    • move template literals to deprecated page
    • discourage dynamic styles
    • move outdated composition syntax to deprecated page
  • Update documentation for Compiled APIs
    • Deprecate styled and ClassNames
    • Merge CSS page into CSS prop
    • Update cssMap to use flat @media query syntax, not the nested one that DST will remove support for
    • Move details about the jsx-pragma ESLint rule to the "JSX pragma" section of the Installation page

dddlr added 5 commits July 11, 2024 15:43
- move template literals to deprecated page
- discourage dynamic styles
- move outdated composition syntax to deprecated page
* Deprecate styled and ClassNames
* Merge CSS page into CSS prop
* Update cssMap to use flat `@media` query syntax, not the nested one that DST will remove support for
* Move details about the `jsx-pragma` ESLint rule to the "JSX pragma" section of the Installation page
Copy link

changeset-bot bot commented Jul 12, 2024

⚠️ No Changeset found

Latest commit: d57cf77

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 Jul 12, 2024

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

Name Link
🔨 Latest commit d57cf77
🔍 Latest deploy log https://app.netlify.com/sites/compiled-css-in-js/deploys/669088780e96a4000853fb8c
😎 Deploy Preview https://deploy-preview-1688--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.

```

Read [composition](/composition) for more information around composing styles together.
The contents of this page have been merged into the [css prop](/api-css-prop) documentation. Check it out!
Copy link
Collaborator Author

Choose a reason for hiding this comment

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

keeping this page just so people don't get 404s

couldn't find an easy way to set up some kind of redirect, or maybe there's a better way you can think of?

@@ -1,4 +1,4 @@
/** @jsxAutomaticRuntime @compiled/react */
/** @jsxImportSource @compiled/react */
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 was a typo that hadn't been noticed for years haha

@dddlr dddlr marked this pull request as ready for review July 12, 2024 01:41
Copy link
Collaborator

@kylorhall-atlassian kylorhall-atlassian left a comment

Choose a reason for hiding this comment

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

Looking good from here!


Create a component that styles a JSX element which comes with built-in behavior such as `ref` and `as` prop support.

<StyledObj />

> **Tagged template expressions** <br /> Tagged template expressions are supported but call expression syntax is preferred.
> **Tagged template expressions** <br /> Tagged template expressions are supported but using object styles is preferred.
Copy link
Collaborator

Choose a reason for hiding this comment

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

Kind of surprised how much stuff changed over time.

@dddlr dddlr merged commit 2e87beb into master Jul 12, 2024
13 checks passed
@dddlr dddlr deleted the chore/docs-revamp-ui-styling-standard branch July 12, 2024 03:31
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.

2 participants