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

Installation documentation shows wrong NPM path to install #150

Open
sun-mota opened this issue Dec 18, 2024 · 1 comment
Open

Installation documentation shows wrong NPM path to install #150

sun-mota opened this issue Dec 18, 2024 · 1 comment
Assignees
Labels
not-reviewed Issue has not been reviewed by Auro team members Type: Bug Bug or Bug fixes

Comments

@sun-mota
Copy link
Contributor

Describe the bug

To Reproduce

Steps to reproduce the behavior:

  1. Go to http://localhost:3000/components/auro/formkit
  2. Click on Formkit
  3. Scroll down to Installation section
  4. All npm links are linked to @auro-formkit/-formkit/-formkit/build-tools

Same on other components' README.md

i.e, checkout README.md has npm I @auro-formkit/-formkit/-formkit/auro-checkbox to install
import "@auro-formkit/-formkit/-formkit/auro-checkbox" to import.

Expected behavior

for formkit,
the path to install should be @aurodesignsystem/auro-formkit

for components,
the path to import should be import "@aurodesignsystem/auro-formkit/components/[component-name]/dist/index.js"

Screenshots

Desktop (please complete the following information):

  • OS: [e.g. iOS]
  • Browser [e.g. chrome, safari]
  • Version [e.g. 22]

Smartphone (please complete the following information):

  • Device: [e.g. iPhone6]
  • OS: [e.g. iOS8.1]
  • Browser [e.g. stock browser, safari]
  • Version [e.g. 22]

Additional context

@sun-mota sun-mota added Type: Bug Bug or Bug fixes not-reviewed Issue has not been reviewed by Auro team members labels Dec 18, 2024
@sun-mota sun-mota assigned blackfalcon and sun-mota and unassigned blackfalcon Dec 18, 2024
@sun-mota sun-mota removed their assignment Dec 18, 2024
@sun-mota
Copy link
Contributor Author

the workaround has been pushed, but not utilizing turbo.
Need further investigation as the workaround was only on the root/README.md

@jason-capsule42 jason-capsule42 changed the title auro-formkit/all components: installation shows wrong npm path to install Installation documentation shows wrong NPM path to install Dec 24, 2024
@jason-capsule42 jason-capsule42 transferred this issue from AlaskaAirlines/AuroDocsSite Dec 24, 2024
@jordanjones243 jordanjones243 self-assigned this Jan 2, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
not-reviewed Issue has not been reviewed by Auro team members Type: Bug Bug or Bug fixes
Projects
None yet
Development

No branches or pull requests

4 participants