Comments (10)
Hey @robsontenorio i am going to work on the docs a bit more before i tag v2.2. It's coming up for sure!
from lighthouse-docs.
Feedback: I am a newcomer, but most of tricks about usage just got from Github issues , not on Docs :(
from lighthouse-docs.
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.
from lighthouse-docs.
I will. Just waiting 2.2 docs release.
from lighthouse-docs.
@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
from lighthouse-docs.
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.
from lighthouse-docs.
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
from lighthouse-docs.
Stuff that i think needs to be done before tagging v2.2:
- #44
- #42
- Document @can, @Complexity, @Middleware and @group under a guide "Security" (not @auth or @security!)
- Add a guide "Relationships" that shows @hasmany and @belongsTo
from lighthouse-docs.
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.
from lighthouse-docs.
Since @chrissm79 and me are using Lighthouse in our work projects and we have limited time, features come first.
from lighthouse-docs.
Related Issues (18)
- Example query using each directive maybe? HOT 7
- Add guide for going from REST -> Lighthouse HOT 4
- Document the namespace functionality of @group HOT 3
- Add links to general resources about GraphQL HOT 1
- Add @rules directive
- add a search functionality HOT 5
- merge directives into one page HOT 5
- Web GraphQL IDE: provide links/options on how to install them HOT 7
- Run docs HOT 3
- [Feat] Add packages HOT 6
- Missing docs for @belongsTo
- This project needs a domain HOT 5
- Duplicated description for where HOT 1
- Document how resolvers default to the configured namespaces HOT 1
- Please use better contrast HOT 1
- [Feature] Provide a CHANGELOG between versions HOT 3
- Documentation page 404 HOT 1
Recommend Projects
-
React
A declarative, efficient, and flexible JavaScript library for building user interfaces.
-
Vue.js
π Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.
-
Typescript
TypeScript is a superset of JavaScript that compiles to clean JavaScript output.
-
TensorFlow
An Open Source Machine Learning Framework for Everyone
-
Django
The Web framework for perfectionists with deadlines.
-
Laravel
A PHP framework for web artisans
-
D3
Bring data to life with SVG, Canvas and HTML. πππ
-
Recommend Topics
-
javascript
JavaScript (JS) is a lightweight interpreted programming language with first-class functions.
-
web
Some thing interesting about web. New door for the world.
-
server
A server is a program made to process requests and deliver data to clients.
-
Machine learning
Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.
-
Visualization
Some thing interesting about visualization, use data art
-
Game
Some thing interesting about game, make everyone happy.
Recommend Org
-
Facebook
We are working to build community through open source technology. NB: members must have two-factor auth.
-
Microsoft
Open source projects and samples from Microsoft.
-
Google
Google β€οΈ Open Source for everyone.
-
Alibaba
Alibaba Open Source for everyone
-
D3
Data-Driven Documents codes.
-
Tencent
China tencent open source team.
from lighthouse-docs.