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

Jump to bottom

[docs] Add Pickers FAQ page #11271

Merged
merged 6 commits into from
Dec 7, 2023
Merged

[docs] Add Pickers FAQ page #11271

merged 6 commits into from
Dec 7, 2023

Conversation

noraleonte
Copy link
Contributor

@noraleonte noraleonte commented Dec 1, 2023 •
edited by oliviertassinari

closes #10887

To be discussed

Placement of the page

The items listed for now (as discussed in the issue) are very specific to the pickers. But the entire MUI X docs can benefit from an FAQ page. We can talk about making this page more generic
Core has a 'How can I contribute' section on their FAQ page. If we decide to create a general page for MUI X too, it could be a good idea to include a section like this.

Other topics

For now, I opened two sections for review: 'What is the DemoContainer' & 'Why isn't the KeyboardDatePicker supported anymore'
We can discuss more topics for this page.

Preview: https://deploy-preview-11271--material-ui-x.netlify.app/x/react-date-pickers/faq/

@noraleonte noraleonte added docs Improvements or additions to the documentation needs cherry-pick The PR should be cherry-picked to master after merge labels Dec 1, 2023
@noraleonte noraleonte self-assigned this Dec 1, 2023
@noraleonte noraleonte marked this pull request as ready for review December 1, 2023 14:17
@mui-bot
Copy link

mui-bot commented Dec 1, 2023 •
edited

Deploy preview: https://deploy-preview-11271--material-ui-x.netlify.app/

Updated pages:

Generated by 🚫 dangerJS against c327850

alexfauquette
alexfauquette approved these changes Dec 1, 2023
View reviewed changes
Copy link
Member

@alexfauquette alexfauquette left a comment

Choose a reason for hiding this comment

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

Looks like a good starting point 👍

docs/data/date-pickers/faq/faq.md Outdated Show resolved Hide resolved
docs/data/date-pickers/faq/faq.md Outdated Show resolved Hide resolved
@alexfauquette
Copy link
Member

Something that could be added in this page is the support of users' locale. It's the second dev I see asking for that #11240

@flaviendelangle
Copy link
Member

I'm not convinced it should be in an FAQ page, we have localization doc pages that are easily findable.
I'd prefer to keep the FAQ for questions we struggle to find a good page for.

joserodolfofreitas
joserodolfofreitas reviewed Dec 5, 2023
View reviewed changes
Copy link
Member

@joserodolfofreitas joserodolfofreitas left a comment

Choose a reason for hiding this comment

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

This is great! Thank you, Nora!

I was looking again at the missing hits,
Should we also add another question about the calendarPicker to the faqs, it was also a component on v5.

image

docs/data/date-pickers/faq/faq.md Outdated Show resolved Hide resolved
@flaviendelangle
Copy link
Member

Should we also add another question about the calendarPicker to the faqs, it was also a component on v5.

If people are struggling to find components because they query the v5 name, the best outcome would be to have the search return the new component.
For instance by having (ex CalendarPicker) in the name

If that's not possible, the FAQ can be a solution

@noraleonte @joserodolfofreitas
Update docs/data/date-pickers/faq/faq.md
c69c7c9 
Co-authored-by: José Rodolfo Freitas <joserodolfo.freitas@gmail.com>
Signed-off-by: Nora <72460825+noraleonte@users.noreply.github.com>
@noraleonte noraleonte mentioned this pull request Dec 5, 2023
Closed
LukasTy
LukasTy approved these changes Dec 7, 2023
View reviewed changes
Copy link
Member

@LukasTy LukasTy left a comment

Choose a reason for hiding this comment

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

Thank you, it's a great addition to the documentation! 👍 🙏
Leaving a few suggestion. 😉

docs/data/date-pickers/faq/faq.md Outdated Show resolved Hide resolved
docs/data/date-pickers/faq/faq.md Show resolved Hide resolved
docs/data/date-pickers/faq/faq.md Outdated Show resolved Hide resolved
docs/data/date-pickers/faq/faq.md Outdated Show resolved Hide resolved
docs/data/date-pickers/faq/faq.md Outdated Show resolved Hide resolved
docs/data/date-pickers/faq/faq.md Outdated Show resolved Hide resolved
@LukasTy LukasTy added the component: pickers This is the name of the generic UI component, not the React module! label Dec 7, 2023
noraleonte and others added 2 commits December 7, 2023 13:25
@noraleonte @LukasTy
Apply suggestions from code review - Lukas
8e9d574 
Co-authored-by: Lukas <llukas.tyla@gmail.com>
Signed-off-by: Nora <72460825+noraleonte@users.noreply.github.com>
@noraleonte @LukasTy
Apply suggestions from code review - Lukas
c327850 
Co-authored-by: Lukas <llukas.tyla@gmail.com>
Signed-off-by: Nora <72460825+noraleonte@users.noreply.github.com>
@noraleonte noraleonte mentioned this pull request Dec 7, 2023
Open
@noraleonte
Copy link
Contributor Author

Opening this issue to discuss how to handle the discoverability of the DateCalendar docs page.

Merging this PR into next now, we can iterate over it and add it to the v6 docs later.

@noraleonte noraleonte merged commit e723473 into mui:next Dec 7, 2023
17 checks passed
@noraleonte noraleonte deleted the faq-page branch December 7, 2023 13:42
LukasTy added a commit to LukasTy/mui-x that referenced this pull request Dec 7, 2023
@noraleonte @joserodolfofreitas @LukasTy
[docs] Add FAQ page (mui#11271)
c4e625c 
Signed-off-by: Nora <72460825+noraleonte@users.noreply.github.com>
Co-authored-by: José Rodolfo Freitas <joserodolfo.freitas@gmail.com>
Co-authored-by: Lukas <llukas.tyla@gmail.com>
@LukasTy LukasTy mentioned this pull request Dec 7, 2023
Merged
@LukasTy LukasTy changed the title [docs] Add FAQ page [docs] Add Pickers FAQ page Dec 8, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@joserodolfofreitas joserodolfofreitas joserodolfofreitas left review comments

@LukasTy LukasTy LukasTy approved these changes

@alexfauquette alexfauquette alexfauquette approved these changes

@flaviendelangle flaviendelangle Awaiting requested review from flaviendelangle

Assignees

@noraleonte noraleonte

Labels
component: pickers This is the name of the generic UI component, not the React module! docs Improvements or additions to the documentation needs cherry-pick The PR should be cherry-picked to master after merge
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

[pickers] FAQ page for the docs.
6 participants
@noraleonte @mui-bot @alexfauquette @flaviendelangle @joserodolfofreitas @LukasTy