Closed siriwatknp closed 2 years ago
@danilo-leal @oliviertassinari @mbrookes Can you take a look at the images for product drawer UI (in the description above), does it make sense to you?
The button for opening product content is moved to the bottom-right of the page (similar to https://reactjs.org/docs/getting-started.html)
For ReactJS it seems that it's only a FAB at mobile breakpoint where a fixed Nav is no longer practical. I don't think having it placed bottom right permanently (if that's the intention) is good UX.
Even if positioned more conventionally, I'm not sure it will be immediately obvious with just the icon how to navigate between products. Perhaps the docs need a home page?
Perhaps the docs need a home page?
How would that help?
Note: The mobile device is only ~3% from google analytics.
How would that help?
By having a top level page that allows for navigation between products, rather than depending on an obscure icon.
Note: The mobile device is only ~3% from google analytics.`
Then why would you chose to optimise for it by using a mobile-first design pattern on desktop? (bottom-right FAB as the primary navigation mechanism for moving between products)
The current plan looks great. A few more thoughts:
I feel that https://mui.com/material-ui/react-modal/ would resonate better than https://mui.com/material/react-modal/. Am I the only one?
+1 on this one
I feel that https://mui.com/material-ui/react-modal/ would resonate better than https://mui.com/material/react-modal/. Am I the only one?
🥲 Another migration, but it looks like it should be mui.com/material-ui/*
.
@oliviertassinari Another thought, is it
https://mui.com/material-ui/react-modal/ or https://mui.com/materialui/react-modal/
? given that we decided to go with "Material UI" without a hyphen.
I had this thought after seeing https://headlessui.dev
Hyphens are commonly placed in URLs in place of spaces, so even though the name of the library is Material UI, to me it's perfectly fine to have material-ui in the URL.
From the decision in the Notion, the documentation will be restructured into each product.
Goal
Incrementally and smoothly transition to the new structure by preserving the same DX for the community and maintainers (tests should be added along the way).
The new repo structure:
Plan
To achieve a smooth transition, the work is split into 3 phases.
1. Preparation
Prepare E2E tests, migration tool, update scripts and add UI (each PR should be able to merge without affecting the production code, either set as feature flag or exclude from production build).
_app.js
to switch between product. #30107docs:api:build
#30245docs:i18n
~ turns out this one needs no change because thetranslations
directory remains the same 😊docs:typescript:formatted
#30248/material/*
for material content. #30286migration.mui.com
to let ahrefs crawl to make sure that all of the links are working as expected. (need to turnenable_redirects
on)2.1 Migrate content
At this phase, the new URLs have to be deployed to production so that algolia can crawl and index. However, before algolia finish the indexing I think we should preserve the old URLs (meaning, people still browsing old URLs and won't realize that we are migrating the content).
yarn docs:migrate:pages && yarn docs:api
. https://github.com/mui-org/material-ui/pull/30757yarn docs:migrate:pages && yarn docs:api
. https://github.com/mui-org/material-ui-x/pull/3730What'd happen after running the scripts
docs/src/pages/*
todocs/data/*
. (Both the old & new URLs are using the same demos, markdowns from the new location so we are always using the single source of truth)enable_product_scope: true
is turned on. This enables several things such as E2E tests for the new URLs, buildApi script, and query markdowns from the new location.yarn docs:api
will generate API pages for both previous & new URLs3. New product spaces
Est. mid of Mar.
material
to/material-ui/*
https://github.com/mui/material-ui/pull/31200enable_mui_base
and initialize MUI Base installation page. https://github.com/mui/material-ui/pull/309694. Go live
Est. 4th April 2022.
5. Clean up
material-redirects.spec
e2e after redirects perioddelete old pages inside
docs/pages/...`replaceHtmlLinks
,replaceUrlLinks
buildApi.ts
parseMarkdown.js
for the API sectioncc @mui-org/core @mui-org/x