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

Please update the top-level README.md #931

Open
drok opened this issue Jan 4, 2025 · 1 comment
Open

Please update the top-level README.md #931

drok opened this issue Jan 4, 2025 · 1 comment
Labels
Bug Something isn't working

Comments

@drok
Copy link

drok commented Jan 4, 2025

Description

What problem are we solving? What does the experience look like today? What are the symptoms? How can one reproduce the problem?

I would like to do some work on the front end, and propose improvements as PR's, but the basic instructions in the README.md file are out of date (eg, cd packages/ia-components && yarn run storybook fails because ia-components does not exist)

Expectation

What should be happening? What will it look like / how will it behave when fixed?

I would expect to be able to spend the little time I have doing productive work, not fighting wrong documentation. If documentation is at all provided, it ought to be maintained.

Outdated/wrong documentation turns potential contributors away.

The first thing I'd like to be able to do is to at least build the static HTML. I can manage some breakage, but in this case it's not at all clear what happened to the ia-components directory, or what I can do next, without risking going down some rabbit hole.

Stakeholders

The directory ia-components was removed by @iisa at 853a55d - I suggest a fixup to that commit with pertinent updates to the README

Thank you.

@drok drok added the Bug Something isn't working label Jan 4, 2025
@NakeshTewari
Copy link

NakeshTewari commented Jan 19, 2025

I am new to open source.I find it difficult to run this proj locally as no ia-components folder exists.Could you help me how to proceed.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Bug Something isn't working
Projects
None yet
Development

No branches or pull requests

2 participants