chore: cleanup Platform FAQs section #17809
Conversation
- Fix grammatical errors - Fix typos (all that I could find at a first-pass) - Improve sentence structure
|
@yeskunall is attempting to deploy a commit to the cal Team on Vercel. A member of the Team first needs to authorize it. |
dosubot
bot
added
docs
| @@ -27,15 +27,14 @@ description: Answers to the most common questions about the Platform API and ato | |||
| - An atom is a customizable UI component that handles scheduling on behalf of your user. | |||
| - Everything from the front-end to API calls is being handled by the atom, all you need to is import the atom and drop it in your code. | |||
|
|
|||
| ### 6. What are the minimun setup requirments for using atoms? | |||
| - You need to have a project that uses React version 18 and above. | |||
| - At the moment atoms are only supported in React, so there's no way to use them in vanilla js or any other popular framework. | |||
There was a problem hiding this comment.
I removed the 2nd bullet point because it is not entirely true. Frameworks like Astro support React, and thus should implicitly support atoms as well. Happy to revert this change if you have proof otherwise.
Graphite Automations"Add consumer team as reviewer" took an action on this PR • (11/22/24)1 reviewer was added to this PR based on Keith Williams's automation. "Add platform team as reviewer" took an action on this PR • (11/22/24)1 reviewer was added to this PR based on Keith Williams's automation. "Add community label" took an action on this PR • (11/22/24)1 label was added to this PR based on Keith Williams's automation. |
| - You need to have a project that uses React version 18 and above. | ||
| - At the moment atoms are only supported in React, so there's no way to use them in vanilla js or any other popular framework. | ||
| ### 6. What are the minimum setup requirements for using atoms? | ||
| At present, atoms are written in React, so your project need to use React version 18 or above. |
There was a problem hiding this comment.
| At present, atoms are written in React, so your project need to use React version 18 or above. | |
| You need to have a project that uses React version 18 and above. | |
| At the moment atoms are only supported in React. |
this looks much clean and easy to understand.
There was a problem hiding this comment.
The second sentence implies this only works in React. Can you show proof of that? Without that, I won’t commit the suggestion as-is.
Either way, maintainers can make edits so feel free to make the change and merge it as you see fit.
There was a problem hiding this comment.
Why are we taking out the hyphens? The other numbered elements have them.
In terms of React, yes, our atoms can only be used with React right now.
|
This PR is being marked as stale due to inactivity. |
|
This PR is being marked as stale due to inactivity. |
|
closing due to inactivity |
What does this PR do?
Mandatory Tasks (DO NOT REMOVE)
How should this be tested?
They’re changes to docs, so head to
/docs/platform/faq. Head there so see the changes.Checklist