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

PM-17068-Implement Docs for Lit Storybook Instance #12912

Merged

Conversation

dan-livefront
Copy link
Collaborator

@dan-livefront dan-livefront commented Jan 16, 2025

🎟️ Tracking

https://bitwarden.atlassian.net/browse/PM-17068

📔 Objective

Created and implemented relevant Docs for Lit instance of StoryBook components. The docs as of now are hidden and not of use in order to avoid overlap with the main instance of StoryBook which currently picks up all mdx files within browser.

Note: I decided to place all the docs in a hidden directory in order to avoid having extensive hidden files throughout multiple directories. Additionally, once this instance is merged into the main instance we will simply have to drag files into their relevant directories and delete the hidden .lit-doc directory.

📸 Screenshots

Screenshot 2025-01-16 at 10 41 28 AM

⏰ Reminders before review

  • Contributor guidelines followed
  • All formatters and local linters executed and passed
  • Written new unit and / or integration tests where applicable
  • Protected functional changes with optionality (feature flags)
  • Used internationalization (i18n) for all UI strings
  • CI builds passed
  • Communicated to DevOps any deployment requirements
  • Updated any necessary documentation (Confluence, contributing docs) or informed the documentation team

🦮 Reviewer guidelines

  • 👍 (:+1:) or similar for great changes
  • 📝 (:memo:) or ℹ️ (:information_source:) for notes or general info
  • ❓ (:question:) for questions
  • 🤔 (:thinking:) or 💭 (:thought_balloon:) for more open inquiry that's not quite a confirmed issue and could potentially benefit from discussion
  • 🎨 (:art:) for suggestions / improvements
  • ❌ (:x:) or ⚠️ (:warning:) for more significant problems or concerns needing attention
  • 🌱 (:seedling:) or ♻️ (:recycle:) for future improvements or indications of technical debt
  • ⛏ (:pick:) for minor or nitpick changes

@dan-livefront dan-livefront self-assigned this Jan 16, 2025
Copy link
Contributor

github-actions bot commented Jan 16, 2025

Logo
Checkmarx One – Scan Summary & Details99d1b8d9-0526-4114-893a-0fca5f8db303

Great job, no security vulnerabilities found in this Pull Request

Copy link

codecov bot commented Jan 16, 2025

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 35.48%. Comparing base (ca53ecc) to head (bee3610).
Report is 1 commits behind head on main.

Additional details and impacted files
@@           Coverage Diff           @@
##             main   #12912   +/-   ##
=======================================
  Coverage   35.48%   35.48%           
=======================================
  Files        3007     3007           
  Lines       90899    90899           
  Branches    16908    16908           
=======================================
  Hits        32260    32260           
  Misses      56137    56137           
  Partials     2502     2502           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@dan-livefront dan-livefront changed the title PM-17068 -add mdx path to lit main file - Add button docs PM-17068-Implement Docs for Lit Storybook Instance Jan 17, 2025
@dan-livefront dan-livefront marked this pull request as ready for review January 22, 2025 16:25
@dan-livefront dan-livefront requested a review from a team as a code owner January 22, 2025 16:25
@dan-livefront dan-livefront requested review from jprusik, blackwood and evan-livefront and removed request for blackwood January 22, 2025 16:29
@blackwood blackwood self-requested a review January 30, 2025 16:23
Copy link

@blackwood blackwood left a comment

Choose a reason for hiding this comment

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

LGTM — I was able to check out the branch and run both storybook instances without cross-contamination. 👍

@dan-livefront dan-livefront merged commit 1d71212 into main Jan 31, 2025
35 checks passed
@dan-livefront dan-livefront deleted the PM-17068-implement-docs-in-new-lit-storybook-instance branch January 31, 2025 20:54
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