Skip to content
This repository has been archived by the owner on Mar 27, 2020. It is now read-only.

Update to docs v2.2 #45

Closed
robsontenorio opened this issue Sep 10, 2018 · 10 comments
Closed

Update to docs v2.2 #45

robsontenorio opened this issue Sep 10, 2018 · 10 comments

Comments

@robsontenorio
Copy link
Contributor

The lighthouse site shows on top v2.1.

https://lighthouse-php.netlify.com

@spawnia
Copy link
Collaborator

spawnia commented Sep 11, 2018

Hey @robsontenorio i am going to work on the docs a bit more before i tag v2.2. It's coming up for sure!

@robsontenorio
Copy link
Contributor Author

Feedback: I am a newcomer, but most of tricks about usage just got from Github issues , not on Docs :(

@spawnia
Copy link
Collaborator

spawnia commented Sep 11, 2018

If you find out how to do something and it is not part of the docs, i invite you to create
a PR. It is really easy, you just have to write some markdown and put it into the files in the /docs directory.

If you need help with contributing, check out the https://github.com/nuwave/lighthouse-docs/blob/master/README.md or hop into Slack.

Another great one is to look at the tests! They are pretty descriptive, since they are mostly end-to-end tests using the SDL.

@robsontenorio
Copy link
Contributor Author

I will. Just waiting 2.2 docs release.

@robsontenorio
Copy link
Contributor Author

robsontenorio commented Sep 16, 2018

@spawnia Docs v2.2 looks great! Why not publish it and improve it incrementally?

It would be useful for newcomers. The 2.1 docs miss a lot of new features already published on main LightHouse package v2.2

@spawnia
Copy link
Collaborator

spawnia commented Sep 16, 2018

The issue i have with that is that we already have some changes laying around that will be only in v2.3. I am trying to get the next branch to a point where it has all of the important stuff of 2.2 in it before we tag it.

It is quite painful to maintain multiple versions and backport additions, so i basically want them in a good state before release.

@spawnia
Copy link
Collaborator

spawnia commented Sep 16, 2018

Feel free to accelerate that process by adding on the the /docs folder, as soon as we feel that is good enough, we will tag it v2.2

@spawnia spawnia reopened this Sep 16, 2018
@spawnia
Copy link
Collaborator

spawnia commented Sep 16, 2018

Stuff that i think needs to be done before tagging v2.2:

@robsontenorio
Copy link
Contributor Author

i really wanna contribute. But, this lack between docs and main package version is painful confusing.

For next versions is there any strategy to keep docs updated with main package version? The best scenario is “just release a package version if we have docs done.

@spawnia
Copy link
Collaborator

spawnia commented Sep 16, 2018

Since @chrissm79 and me are using Lighthouse in our work projects and we have limited time, features come first.

Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants