[docs] Update folder structure #744
Conversation
vladmoroz
requested review from
atomiks,
colmtuite and
michaldudak
as code owners
| <span className="only-light-mode"> | ||
| <img | ||
| src="/static/docs-infra/forking-an-example.png" | ||
| alt="Forking an example" | ||
| loading="lazy" | ||
| width="1628" | ||
| style={{ display: 'block', maxWidth: '774px' }} | ||
| /> | ||
| </span> | ||
| <span className="only-dark-mode"> | ||
| <img | ||
| src="/static/docs-infra/forking-an-example-dark.png" | ||
| alt="Forking an example" | ||
| loading="lazy" | ||
| width="1628" | ||
| style={{ display: 'block', maxWidth: '774px' }} | ||
| /> | ||
| </span> | ||
|
|
There was a problem hiding this comment.
This was outdated and the doc will be reworked anyway
| const { MDXContent, tableOfContents, metadata } = await getMarkdownPage(CATEGORY_SEGMENT, slug); | ||
| const { MDXContent, tableOfContents, metadata } = await getMarkdownPage( | ||
| CATEGORY_SEGMENT, | ||
| slug, | ||
| ); |
There was a problem hiding this comment.
Seems like there was some column width change at some point in the Prettier config? Anyway, Prettier wanted to touch up many files, so lots of unrelated formatting changes here
Netlify deploy preview |
.codesandbox/ci.json
Outdated
| @@ -6,6 +6,6 @@ | |||
| "publishDirectory": { | |||
| "@base_ui/react": "packages/mui-base/build" | |||
| }, | |||
| "sandboxes": ["/examples/base-ui-cra-ts"], | |||
| "sandboxes": ["react-vite-ts"], | |||
There was a problem hiding this comment.
This doesn't really make sense, as react-vite-ts doesn't depend on @base_ui/react. I'd ask the team if they would find the sandboxes generated per PR useful, and if yes, I'd leave just this one directory in /examples. Otherwise, we can remove the sandboxes.
There was a problem hiding this comment.
I think they are going to be useful, yeah. I hadn't used CodeSandbox CI before, but from reading the description it sounds like something that would be good to set up once we go a bit more public.
Thoughts on putting the template it /.codesandbox/template/?
No big deal but /examples/ sets up the expectation to see something that resembles a less or more complete app built with Base UI
There was a problem hiding this comment.
Updated with /.codesandbox/template/, lmk if this works for you
There was a problem hiding this comment.
I have never used this "sandboxes" feature of CodeSandbox CI
https://ci.codesandbox.io/status/mui/base-ui/pr/744/builds/552351
I suspect that we can delete this
| "sandboxes": ["react-vite-ts"], |
Starting from https://deploy-preview-744--base-ui.netlify.app/components/react-field/ feels much more convenient:
vladmoroz
force-pushed
the
folder-structure
branch
from
a8b4100 to
0dc931b
Compare
/examples.codesandbox/templateas it's referenced in the CodeSandbox CI config/docs/appto/docs/src/app