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.

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

[docs] Add small formatting improvements to the licensing page #11178

Merged
merged 6 commits into from
Nov 28, 2023

Conversation

danilo-leal
Copy link
Contributor

@danilo-leal danilo-leal commented Nov 25, 2023

While working on mui/material-ui#39832, I noticed a few relatively quick improvement opportunities for the MUI X docs! This one adds in just some minor copywriting and formatting tweaks to make the page more consistent:

  • Remove unnecessary backticks from headings
  • Capitalize the components' names
  • Remove callouts when possible

👉 https://deploy-preview-11178--material-ui-x.netlify.app/x/introduction/licensing/

@danilo-leal danilo-leal added the docs Improvements or additions to the documentation label Nov 25, 2023
@mui-bot
Copy link

mui-bot commented Nov 25, 2023

docs/data/introduction/licensing/licensing.md Outdated Show resolved Hide resolved
docs/data/introduction/licensing/licensing.md Outdated Show resolved Hide resolved
docs/data/introduction/licensing/licensing.md Outdated Show resolved Hide resolved
docs/data/introduction/licensing/licensing.md Outdated Show resolved Hide resolved
docs/data/introduction/licensing/licensing.md Outdated Show resolved Hide resolved
docs/data/introduction/licensing/licensing.md Outdated Show resolved Hide resolved
docs/data/introduction/licensing/licensing.md Outdated Show resolved Hide resolved
docs/data/introduction/licensing/licensing.md Outdated Show resolved Hide resolved
docs/data/introduction/licensing/licensing.md Outdated Show resolved Hide resolved
docs/data/introduction/licensing/licensing.md Outdated Show resolved Hide resolved

The Pro version is available under a commercial license—visit [the Pricing page](https://mui.com/r/x-get-license/) for details.
Exclusive features are marked with the <span class="plan-pro" aria-label="MUI X Pro plan icon"></span> icon throughout the documentation.
Copy link
Member

Choose a reason for hiding this comment

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

beyond the scope of this PR but we should track down all of these lil plan spans and give them all aria labels where they're missing

Copy link
Member

Choose a reason for hiding this comment

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

I checked out these spans in the navigation bar and they all appear to have a title that the screen reader picks up as an ARIA label, but I suspect there may be others scattered around in the Markdown that don't have them.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

For sure, yeah! I'm just now getting deeper into the X docs space, so definitely looking forward to doing it!

Copy link
Member

@samuelsycamore samuelsycamore left a comment

Choose a reason for hiding this comment

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

Looks good! Just found one more awkward sentence in this pass :)

docs/data/introduction/licensing/licensing.md Outdated Show resolved Hide resolved
@danilo-leal danilo-leal merged commit c4fb153 into mui:next Nov 28, 2023
17 checks passed
@danilo-leal danilo-leal deleted the licensing-page-copy-tweaks branch November 28, 2023 11:38
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docs Improvements or additions to the documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

4 participants