[docs] Reference shared code from the Core monorepo #326
Conversation
michaldudak
force-pushed
the
docs-cleanup
branch
from
eca0e49
to
34b1e05
Compare
|
|
||
| export default function Page() { | ||
| return <MarkdownDocs {...pageProps} />; | ||
| return <MarkdownDocs {...pageProps} disableAd />; |
There was a problem hiding this comment.
Added disableAd for consistency with other pages
docs/scripts/reportBrokenLinks.js
Outdated
There was a problem hiding this comment.
Copied from the X repo
github-actions
bot
added
the
PR: out-of-date
oliviertassinari
changed the title
| # Fix links to other MUI products in deploy previews | ||
| /base-ui/* /base-ui/:splat 200 | ||
| /* https://mui.com/:splat 301 | ||
|
|
There was a problem hiding this comment.
I wonder if we should add this:
- It's not clear to me that it will work if we redirection /base-ui/ URLs
- If it does work, then it sounds like something all repositories should have, e.g. MUI X
- But then https://www.notion.so/mui-org/docs-infra-Change-docs-domain-0ce329e7ebc34aba8fbf4f3c5e13eb5d. it might quickly not have value with Base UI in a different URL location.
So maybe to keep this PR a bit more focused (adoption of docs infra != improving docs infra):
| # Fix links to other MUI products in deploy previews | |
| /base-ui/* /base-ui/:splat 200 | |
| /* https://mui.com/:splat 301 |
There was a problem hiding this comment.
I did this to avoid reverting #321. Since we now reference routes from the monorepo, we can't control them.
This will be less important when we publish the site under mui.com, but for now, as deployment previews are the only public docs we have, IMO, it's better to have the links working.
Besides, this way we can try out it if there are any issues with this approach.
There was a problem hiding this comment.
Interesting PR (#321), in MUI X/Toolapd the read on this problem was that it was ok. A 404 is clearer than a URL change to figure what MUI page is hosted where.
Now, having these links working helps ensure that once the preview is deployed to production, ahrefs weekly crawl won't find 404 links, so fair enough.
If https://github.com/mui/mui-x/blob/41fb8d93c52eb97557e41c7784a22ac901e06846/docs/public/_redirects#L40 like redirections work, 👍 to propagate this to all the docs-infra consumers.
There was a problem hiding this comment.
It seems to work. I added a test redirect in d6e1c2c and the site redirects me as expected: https://662678144d579d0008951e2b--base-ui.netlify.app/base-ui/test-redirect/
There was a problem hiding this comment.
Nice. We will see how this behaves once integrated in mui.com 👍.
I wonder how we will plan the mui.com/base-ui/ to base-ui.mui.com/ migration.
github-actions
bot
added
PR: out-of-date
| headers: PropTypes.object.isRequired, | ||
| }).isRequired, | ||
| }; | ||
| export { default } from 'docs/src/modules/components/ComponentLinkHeader'; |
There was a problem hiding this comment.
Why are this and ComponentPageTabs not exported from @mui/doc?
There was a problem hiding this comment.
They must be present locally as they are included in markdown files (with the {"component": ... syntax)
github-actions
bot
removed
the
PR: out-of-date
michaldudak
force-pushed
the
docs-cleanup
branch
from
6d9700c
to
d6e1c2c
Compare
This is a more complete version of #158.
I removed all the common components and left only the ones specific to the Base UI docs site.
@mnajdova you may need to do a similar exercise for the Pigment CSS docs.
Preview: https://deploy-preview-326--base-ui.netlify.app/base-ui/getting-started/