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

docs: improve get started #2547

Open
bennypowers opened this issue Jul 9, 2023 · 0 comments
Open

docs: improve get started #2547

bennypowers opened this issue Jul 9, 2023 · 0 comments
Labels
docs Documentation updates good 1st issue Good for newcomers to the project; requires at least an introductory knowledge of the language red hack day Good issue for Red Hack Day

Comments

@bennypowers
Copy link
Member

@tkitslaar writes:

Firstly I would emphasize installing then making sure users know to also include the import statements...using the get started page for example, the currently layout/wording doesn't make it clear that you should do the npm install first then the import options, as the wording says it will install pf-card or whatever element you're using via npm, so it kinda comes across as an either or. That's a pretty easy fix of just making the docs more process oriented. This is probably pretty obvious if you've done a lot of web component work but my impression using other systems was that each do it a little bit differently, some only use import statements and not npm, etc, so I tended to follow the laid out process pretty closely.

Secondly and maybe more importantly, the usage instructions for each component completely omit the import statements, which without them the component wont work. So under usage on each component page I would add the proper import statement for each component i.e. import '@patternfly/elements/pf-card/pf-card.js'; or whatever, with each component having the proper relevant import statement specific to its component so users can easily copy paste and get up and running with whatever component is being used. The other related issue here is it leaves the user to guess and figure out what the right import statement is just based on the one example given on the getting started page, i.e. import '@patternfly/pfe-tabs/dist/pfe-tabs.min.js'; for V1 pfe-tabs based off of the example of import '@patternfly/pfe-card/dist/pfe-card.min.js'; given in the getting started section, which I could imagine getting tedious if you're using a lot of different components.

@bennypowers bennypowers added the docs Documentation updates label Jul 9, 2023
@bennypowers bennypowers added the good 1st issue Good for newcomers to the project; requires at least an introductory knowledge of the language label Jun 10, 2024
@markcaron markcaron added the red hack day Good issue for Red Hack Day label Jun 13, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docs Documentation updates good 1st issue Good for newcomers to the project; requires at least an introductory knowledge of the language red hack day Good issue for Red Hack Day
Projects
None yet
Development

No branches or pull requests

2 participants