Next.js: Add api reference

[dimensi]

Could you please add api reference to the documentation with a detailed description of each method for each entity? To go through the documentation without the ability to see immediately available api, spoils the blood.
As here https://reactjs.org/docs/react-api.html or here https://vuejs.org/v2/api/
Attempting to sort out and collect piece of information from the documentation, learn, and source code and types, spends a lot of time

[javiercr]

Same thing, I was struggling to find out why Router.push has two different method signatures according to the docs (one where the first arg is an object, and another where the first arg is a string).

Other than that, next.js is pretty cool :)

[Ovyerus]

I reckon this is pretty essential, especially for as large of a framework as this.

[iest]

+1 on this, the documentation is pretty torturous to actually find what you're looking for.

Happy to help with this but not sure where to actually put the docs. Perhaps just in the next package's README?

[jhwheeler]

+1 on this. While the docs have lots of good information, I would really appreciate a place where the props for each component are listed, e.g. , etc.

[jkjustjoshing]

I recommend taking advantage of https://hacktoberfest.digitalocean.com like the Gatsby project did last year https://www.gatsbyjs.org/blog/2018-10-12-uptick-docs-contributions-hacktoberfest/. This is one of the reasons I think they've been able to build such good documentation.

The NextJS team would need to define how they want the documentation structured, and create a list of all the pages they want to exist, and then let the open source community do all the actual work of writing the docs/researching the API.

You've got 3 weeks to set this up!

[ghost]

+1 from me.