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] API pages i18n #23214

Merged
merged 58 commits into from
Nov 16, 2020
Merged

[docs] API pages i18n #23214

merged 58 commits into from
Nov 16, 2020

Conversation

mbrookes
Copy link
Member

@mbrookes mbrookes commented Oct 23, 2020 •
edited
Loading

image

Key files

Generate:

  • docs/scripts/buildApi.ts

Translations:

  • docs/translations/component-descriptions.json
  • docs/translations/prop-descriptions.json
  • docs/translations/class-descriptions.json

Example API docs:

  • docs/pages/api-docs/accordion.js
  • docs/pages/api-docs/accordion.json

Render:

  • docs/src/modules/components/ApiDocs.js

NB

The script exits early so only Accordion is updated, in order to make the PR easier to review (19 changed files rather than 400+). That will obviously need to be updated before it can be merged.

@mbrookes mbrookes added the docs Improvements or additions to the documentation label Oct 23, 2020
@mui-pr-bot
Copy link

mui-pr-bot commented Oct 23, 2020 •
edited
Loading

Details of bundle changes

Generated by 🚫 dangerJS against 3f6f086

@mbrookes mbrookes force-pushed the docs-api-i18n branch 2 times, most recently from 4e94d52 to 8b5f6e9 Compare October 23, 2020 02:54
@github-actions github-actions bot added the PR: out-of-date The pull request has merge conflicts and can't be merged label Oct 23, 2020
@mbrookes mbrookes force-pushed the docs-api-i18n branch 2 times, most recently from 90d33aa to 9d290bf Compare October 23, 2020 22:40
@github-actions github-actions bot removed the PR: out-of-date The pull request has merge conflicts and can't be merged label Oct 23, 2020
@mbrookes mbrookes marked this pull request as ready for review October 23, 2020 23:40
@mbrookes mbrookes force-pushed the docs-api-i18n branch 3 times, most recently from 4e7d692 to 4bebf50 Compare October 24, 2020 02:58
@github-actions github-actions bot mentioned this pull request Oct 24, 2020
Closed
@mbrookes mbrookes force-pushed the docs-api-i18n branch 2 times, most recently from a3c3a73 to 4fb356b Compare October 24, 2020 23:14
@github-actions github-actions bot added PR: out-of-date The pull request has merge conflicts and can't be merged and removed PR: out-of-date The pull request has merge conflicts and can't be merged labels Oct 24, 2020
@github-actions github-actions bot added the PR: out-of-date The pull request has merge conflicts and can't be merged label Nov 15, 2020
@github-actions github-actions bot removed the PR: out-of-date The pull request has merge conflicts and can't be merged label Nov 15, 2020
@mbrookes mbrookes marked this pull request as ready for review November 15, 2020 15:40
@github-actions github-actions bot added the PR: out-of-date The pull request has merge conflicts and can't be merged label Nov 16, 2020
@github-actions github-actions bot removed the PR: out-of-date The pull request has merge conflicts and can't be merged label Nov 16, 2020
@oliviertassinari
Copy link
Member

oliviertassinari commented Nov 16, 2020 •
edited
Loading

I couldn't spot anything major. Browser performance seems the same, build time on Netlify seems the same. Happy to be one step closer to a similar DX as https://vuetifyjs.com/zh-Hans/api/v-avatar/.

@mbrookes mbrookes merged commit 7fbaefa into mui:next Nov 16, 2020
@mbrookes mbrookes deleted the docs-api-i18n branch November 16, 2020 21:14
eps1lon
eps1lon reviewed Nov 17, 2020
View reviewed changes
Copy link
Member

@eps1lon eps1lon left a comment

Choose a reason for hiding this comment

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

Awesome stuff!

eps1lon added a commit to eps1lon/material-ui that referenced this pull request Nov 17, 2020
@eps1lon
Revert "[docs] API pages i18n (mui#23214)"
2263db3 
This reverts commit 7fbaefa.
This was referenced Nov 17, 2020
Merged
Closed
@eps1lon
Copy link
Member

eps1lon commented Nov 17, 2020

Awesome stuff!

Premature celebration. Had to revert this PR (#23581) since it doesn't work when deployed with all locales. There are also some changes that I didn't see discussed so let's rewind and then replay slowly in little iterations not one big sweeping change.

oliviertassinari pushed a commit that referenced this pull request Nov 25, 2020
@mbrookes @oliviertassinari
[docs] API pages i18n (#23214)
1403e9d
@oliviertassinari oliviertassinari mentioned this pull request Nov 25, 2020
Closed
oliviertassinari pushed a commit to oliviertassinari/material-ui that referenced this pull request Nov 25, 2020
@mbrookes @oliviertassinari
[docs] API pages i18n (mui#23214)
cf17484
oliviertassinari pushed a commit to oliviertassinari/material-ui that referenced this pull request Nov 25, 2020
@mbrookes @oliviertassinari
[docs] API pages i18n (mui#23214)
16b9f53
@oliviertassinari oliviertassinari mentioned this pull request Nov 28, 2020
Closed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@eps1lon eps1lon eps1lon left review comments

@AGDholo AGDholo AGDholo left review comments

@jaironalves jaironalves jaironalves left review comments

@oliviertassinari oliviertassinari oliviertassinari approved these changes

Assignees
No one assigned
Labels
docs Improvements or additions to the documentation
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
6 participants
@mbrookes @mui-pr-bot @eps1lon @oliviertassinari @AGDholo @jaironalves