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

WIP: embed ladle stories in documentation #144

Merged
merged 3 commits into from
Dec 27, 2024

Conversation

orteth01
Copy link
Contributor

@orteth01 orteth01 commented Dec 26, 2024

Early WIP For feedback

to test:
from the root directory run

  • pnpm --filter=@accelint/docs build
  • pnpm --filter=@accelint/docs preview
  • navigate to /packages/design-system/component-stories.html

demo:

Screen.Recording.2024-12-26.at.2.25.35.PM.mov

Warning

The embed does not currently work when running the pnpm --filter=@accelint/docs dev command. Rspress wipes out the dist directory when we run the dev command. i'm going to look into workarounds.

✅ Pull Request Checklist:

  • Included link to corresponding GitHub Issue.
  • The commit message follows conventional commit extended guidelines.
  • Added/updated unit tests and storybook for this change (for bug fixes / features).
  • Added/updated documentation (for bug fixes / features)
  • Filled out test instructions.

📝 Test Instructions:

❓ Does this PR introduce a breaking change?

  • Yes
  • No

💬 Other information

@orteth01 orteth01 requested a review from kalisjoshua December 26, 2024 21:34
@@ -3,7 +3,8 @@
"version": "0.1.0",
"private": true,
"scripts": {
"build": "rspress build",
"build": "rspress build && pnpm run build-ladle",
"build-ladle": "pnpm --filter=@accelint/design-system exec ladle build -o ../../apps/docs/dist/ladle --base ladle",
Copy link
Contributor Author

Choose a reason for hiding this comment

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

@kalisjoshua
Copy link
Contributor

I know it isn't the ideal solution but I also know that it isn't the endgame. We can continue to refine it as we go; in fact we will need to. I do, however, believe that we need to have a single experience for the user not two different sites.

@orteth01 orteth01 marked this pull request as ready for review December 27, 2024 14:13
@orteth01 orteth01 merged commit 2b78dd9 into feat/126-docs Dec 27, 2024
3 checks passed
@orteth01 orteth01 deleted the to/embed-ladle-in-docs branch December 27, 2024 16:52
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants