Skip to content

feat(public-docsite-v9): Add recipes to concepts section #27747

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.

Sign up for GitHub

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

Closed
sopranopillow wants to merge 1 commit into from
Closed

feat(public-docsite-v9): Add recipes to concepts section #27747

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions apps/public-docsite-v9/.storybook/main.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,7 @@ module.exports = /** @type {Omit<import('../../../.storybook/main'), 'typescript
'../../../packages/react-components/react-migration-v0-v9/stories/**/@(index.stories.@(ts|tsx)|*.stories.mdx)',
'../../../packages/react-components/react-migration-v8-v9/stories/**/@(index.stories.@(ts|tsx)|*.stories.mdx)',
'../../../packages/react-components/react-datepicker-compat/stories/**/@(index.stories.@(ts|tsx)|*.stories.mdx)',
'../../recipes-react-components/src/recipes/**/*.stories.mdx',

@Hotell Hotell May 3, 2023

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

hmm this feels wrong from domain boundary POV. an app should never use things from another app. In future we will have in place lint rules that would not allow this.

Don't wanna block the progress here thus can you please create issue to fix this going forward ?

@sopranopillow sopranopillow May 3, 2023

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

In that case, what would be the way to go with this? should this be a package instead to avoid this issue?

@Hotell Hotell May 10, 2023

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

yeah, AFAIR the intent of recipes was to be as standalone app correct ? but if we wanna make it part of v9 docs it is no longer true.

We still can have it as an app to be published standalone though, if there is such a need etc.

NOTE: make sure to make the library private as we don't wanna expose it to npm registry.

@sopranopillow sopranopillow May 10, 2023

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

Hmm I'll talk with everyone else, but as I understand we wanted it to be pretty visible in the docs since we will use them as placeholder recipes for components that we might work on later. I'll change it to draft for now.

@Hotell Hotell May 17, 2023

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

nothing will change in terms of "visibility"

it will only change import.

'../../../packages/react-components/src/recipes/**/*.stories.mdx',

then the app will can still exist but with dependency on library

recipes-app --> recipes-lib

@sopranopillow sopranopillow May 17, 2023

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

so there's no problem having the package never released and private? I think that was a concern that made us go with the app instead of package. This package wouldn't follow semver as well since we'll allow breaking changes and such. If those things aren't problems, then I'll create a PR to move it to a package in the coming days.

@Hotell Hotell May 29, 2023

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

yeah I dont see any problem with that. if it's gonna be private even better. ty!

],
staticDirs: ['../public'],
addons: [...rootMain.addons],
Expand Down
1 change: 1 addition & 0 deletions apps/public-docsite-v9/.storybook/preview.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -44,6 +44,7 @@ export const parameters = {
['Component Mapping', 'Color Mapping', 'Troubleshooting'],
'from v0',
],
'Recipes',
],
'Theme',
'Components',
Expand Down