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

Include Code Snippets for Package Installation #57

Open
1 task done
confused-Techie opened this issue Feb 2, 2023 · 2 comments
Open
1 task done

Include Code Snippets for Package Installation #57

confused-Techie opened this issue Feb 2, 2023 · 2 comments
Labels
enhancement New feature or request

Comments

@confused-Techie
Copy link
Member

Have you checked for existing feature requests?

  • Completed

Summary

As suggested by @Daeraxa including code snippets for how to install packages would help display the methods of installation and tie things in closer to the actual Pulsar application.

I.E. pulsar -p install atom-clock or ppm install atom-clock

What benefits does this feature provide?

Similar to NPM makes things easier to those working on the CLI to use the resources found on the web

Any alternatives?

Make people figure it out on their own I suppose

Other examples:

No response

@confused-Techie confused-Techie added the enhancement New feature or request label Feb 2, 2023
@confused-Techie
Copy link
Member Author

@Daeraxa Just was thinking about this one.

Since we have a rather simple layout of the metadata of the package at the top of a page, then the actual readme content below, where exactly do we want to put installation instructions.

Do we want to go the route of NPMjs and put them on a new sidebar, or would we rather include them as new section underneath the package metadata details? Or somewhere else that I haven't thought of

@Daeraxa
Copy link
Member

Daeraxa commented Feb 7, 2023

I've come up with two relatively simple ideas of how to implement it. I do think that just putting them with the rest of the metadata makes sense.

The two examples (forgive the mix and match of themes, this wasn't done "properly", just with some html editing and paint.

  1. Using a new dropdown on the install box like the share box:
    image

  2. Move the install button down and make a new text section that can be copied to clipboard
    image

There is a question as to if we want to extend the functionality (not necessarily a final design) to the small package cards as well (the ones on the list and featured pages).

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

2 participants