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] More docs infra changes #304

Merged
merged 1 commit into from
Nov 11, 2024
Merged

Conversation

brijeshb42
Copy link
Contributor

@brijeshb42 brijeshb42 commented Nov 6, 2024

  • Separate text content and it's wrapper's styles
  • Use env variables for constants
  • Use docs infra config from @mui/monorepo
  • Correctly link md or mdx files to Github
  • Hide version selector if it has only one version
  • Simplify and enable bottom pagination style
  • Setup code highlighting of mdx code content with built-in shiki theme
Screenshot 2024-11-06 at 4 51 49 PM

@brijeshb42 brijeshb42 added the scope: docs-infra Specific to the docs-infra product label Nov 6, 2024
@brijeshb42 brijeshb42 force-pushed the docs-update branch 6 times, most recently from a2d7476 to f57f341 Compare November 11, 2024 08:31
* Separate text content and it's wrapper's styles
* More use of env variables for constants
* Use docs infra config from @mui/monorepo
* Correctly link md or mdx files to Github
* Hide version selector if it has only one version
* Simplify and enable bottom pagination style
* Setup code highlighting of mdx code content with built-in shiki theme

const nextConfig: NextConfig = {
trailingSlash: false,
env: {
DATA_DIR,
CURRENT_VERSION: rootPackage.version,
Copy link
Member

Choose a reason for hiding this comment

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

Where is this used?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

To be used in version dropdown (or span).

@@ -45,7 +45,9 @@ export function AppBar() {
<IconLinkButton useNextLink href="/" label="Pigment CSS" size={3}>
<PigmentIcon />
</IconLinkButton>
<DocsVersionSelector currentVersion={currentVersion} versions={supportedVersions} />
{supportedVersions.length > 1 && (
Copy link
Member

Choose a reason for hiding this comment

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

Instead of hiding we can have a span to show the current version.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Will update in a followup.

Copy link
Member

@mnajdova mnajdova left a comment

Choose a reason for hiding this comment

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

The changes make sense in general, I've added few comments/questions. It would be ideal to have a use-cases for all changes in order to be able to test them in more details.

@brijeshb42
Copy link
Contributor Author

It would be ideal to have a use-cases for all changes in order to be able to test them in more details.

Makes sense. I was testing locally with stubs. Going forward, most of the PRs for docs will be about the actual content. So we'll get a better idea then.

@brijeshb42 brijeshb42 merged commit e74aa0e into mui:master Nov 11, 2024
15 checks passed
@brijeshb42 brijeshb42 deleted the docs-update branch November 11, 2024 14:31
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
scope: docs-infra Specific to the docs-infra product
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants