Skip to content

Comments

chore(README): recommend using npm pack and styleguidist instead of npm link#8018

Merged
ChristophWurst merged 1 commit intomainfrom
chore/npm-link
Dec 18, 2025
Merged

chore(README): recommend using npm pack and styleguidist instead of npm link#8018
ChristophWurst merged 1 commit intomainfrom
chore/npm-link

Conversation

@ShGKme
Copy link
Contributor

@ShGKme ShGKme commented Dec 17, 2025

☑️ Resolves

  • We still recommend using npm link for development, but:
    • In many cases it is easier to use styleguide
    • npm link leads to issues and should be replaced with npm pack

🚧 Tasks

  • Remove npm link instructions
  • Add npm pack instructions
  • Move styleguidist instructions and adjust a bit

@ShGKme ShGKme self-assigned this Dec 17, 2025
@ShGKme ShGKme added 3. to review Waiting for reviews feature: documentation Related to the documentation labels Dec 17, 2025
@ShGKme
Copy link
Contributor Author

ShGKme commented Dec 17, 2025

I'm not sure Using vue-devtools in Firefox is still actual for this library.
Will check and remove in another PR is neede.

@codecov
Copy link

codecov bot commented Dec 17, 2025

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 53.25%. Comparing base (7e3cbea) to head (911664f).
⚠️ Report is 2 commits behind head on main.

Additional details and impacted files
@@           Coverage Diff           @@
##             main    #8018   +/-   ##
=======================================
  Coverage   53.25%   53.25%           
=======================================
  Files         101      101           
  Lines        3145     3145           
  Branches      872      871    -1     
=======================================
  Hits         1675     1675           
  Misses       1232     1232           
  Partials      238      238           

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

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
  • 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

@ChristophWurst ChristophWurst merged commit fe10020 into main Dec 18, 2025
27 checks passed
@ChristophWurst ChristophWurst deleted the chore/npm-link branch December 18, 2025 10:20
@Antreesy Antreesy mentioned this pull request Jan 8, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

3. to review Waiting for reviews feature: documentation Related to the documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants