-
-
Notifications
You must be signed in to change notification settings - Fork 46
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
Conversation
brijeshb42
commented
Nov 6, 2024
•
edited
Loading
edited
- 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
- I have followed (at least) the PR section of the contributing guide.
b7ef6f7
to
62d641f
Compare
a2d7476
to
f57f341
Compare
* 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
f57f341
to
abc48b8
Compare
|
||
const nextConfig: NextConfig = { | ||
trailingSlash: false, | ||
env: { | ||
DATA_DIR, | ||
CURRENT_VERSION: rootPackage.version, |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Where is this used?
There was a problem hiding this comment.
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 && ( |
There was a problem hiding this comment.
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.
There was a problem hiding this comment.
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.
There was a problem hiding this 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.
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. |