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.

Sign up for GitHub

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

chore: cleanup Platform FAQs section #17809

Closed
wants to merge 2 commits into from
Closed

chore: cleanup Platform FAQs section #17809

Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
0a87ca8
chore: cleanup Platform FAQs section
yeskunall Nov 22, 2024
5fc5e91
Merge branch 'main' into patch-2
yeskunall Nov 25, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 5 additions & 6 deletions docs/platform/faq.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Copy link
Contributor Author

Choose a reason for hiding this comment

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

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.

### 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.
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
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.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

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.

Copy link
Contributor

Choose a reason for hiding this comment

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

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.


### 7. Can recurring events be rescheduled?
- No, at the moment you are only allowed to cancel a recurring event.
No, at the moment you are only allowed to cancel a recurring event.

### 8. Why toggle animation is not working in the AvailabilitySettings atom?
- For the AvailabilitySettings toggle animation to work set the reading direction on the `<html>` element:
### 8. Why is the toggle animation not working in the `AvailabilitySettings` atom?
Set the reading direction on the `<html>` element for the toggle animation to work:
```html
<html dir="ltr"> ... </html>
```
Expand Down
Loading