Skip to content
This repository has been archived by the owner on Feb 18, 2024. It is now read-only.

README hierarchy - Quickstart/installation #644

Closed
timkelty opened this issue Dec 21, 2017 · 3 comments
Closed

README hierarchy - Quickstart/installation #644

timkelty opened this issue Dec 21, 2017 · 3 comments
Assignees
@edmorley
Labels
docs good first issue
Milestone
Neutrino 9

Comments

@timkelty
Copy link
Contributor

timkelty commented Dec 21, 2017 •
edited
Loading

Seems a bit odd to me that "Quickstart" (added by #610) does not precede "Installation" in package docs (eg https://github.com/mozilla-neutrino/neutrino-dev/tree/master/packages/web)

Seems to me a more sensible hierarchy would be:

  • Features
  • Requirements
  • Quickstart
    • create-project
    • Manual Installation
      (including yarn/npm steps that are currently under "Installation"
  • Project Layout…
@divyabaid16
Copy link

Can I work on this issue ?

@eliperelman
Copy link
Member

@divyabaid16 sure thing! Have a look at the contributing guide as well as the docs layout.

Feel free to reach out if you have any questions or encounter issues. Thanks!

divyabaid16 added a commit to divyabaid16/neutrino-dev that referenced this issue Feb 22, 2018
@divyabaid16
Update Readme - changing the hierarchy
1d62ab9 
(neutrinojs#664)[neutrinojs#644]
@divyabaid16 divyabaid16 mentioned this issue Feb 22, 2018
Closed
@divyabaid16
Copy link

Please review the PR !

@edmorley edmorley mentioned this issue Mar 24, 2019
Merged
@edmorley edmorley self-assigned this Mar 24, 2019
@edmorley edmorley added this to the Neutrino 9 milestone Mar 24, 2019
edmorley added a commit that referenced this issue Mar 24, 2019
@edmorley
docs: Move the quickstart section above manual installation (#1339)
1b94390 
Since for most users it will be the easiest way to get started.

Fixes #644.
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Assignees

@edmorley edmorley

Labels
docs good first issue
Milestone
Neutrino 9
Development

No branches or pull requests
4 participants
@timkelty @eliperelman @edmorley @divyabaid16