rsnext/docs
Alex Castle 5d7b68f15e
Overhaul image component documentation (#29186)
This PR contains an overhaul of the image component documentation for next (both the [primary usage doc](https://nextjs.org/docs/basic-features/image-optimization) and the [API reference](https://nextjs.org/docs/api-reference/next/image)). This PR does not change the filepath/URL for either of those documents, but that may still be warranted as right now Google searches for "next.js image component" and the like return the API document as the first result, which is not optimal.

The changes to the docs are based on feedback from the community and with input from @leerob. I'm marking this PR a draft because we will likely want to have a round of revisions before merging, but in general I consider this PR "read to go," contingent on buy-in from other stakeholders.

The basic goal of the changes are as follows:
1. Simplify the getting started page by moving extraneous detail to the API documentation.
2. Refocus the getting started page on practical usage information
3. Add additional content to address issues that have come up as common pain-points around the image component, such as image sizing and styling.

Fixes #21786 

CC: @styfle @timneutkens @kara @spanicker
2021-10-05 21:38:48 +00:00
..
advanced-features docs: Link to getInitialProps on Custom App page (#29567) 2021-10-02 21:39:08 +00:00
api-reference Overhaul image component documentation (#29186) 2021-10-05 21:38:48 +00:00
api-routes doc: fix typo (#28817) 2021-09-06 13:42:18 +02:00
basic-features Overhaul image component documentation (#29186) 2021-10-05 21:38:48 +00:00
migrating Update Gatsby migration guide to use image imports. (#29178) 2021-09-19 00:12:31 -05:00
routing Update imperative routing docs to have better a11y (#29382) 2021-09-27 02:04:58 +00:00
authentication.md Use new @clerk/nextjs package in with-clerk example, update Next.js authentication docs (#28906) 2021-09-17 10:54:34 -05:00
deployment.md Add note about using Sharp for next/image to deployment docs. (#29067) 2021-09-13 20:31:04 +00:00
faq.md Update .now.sh to .vercel.app. (#22359) 2021-04-14 09:46:06 -05:00
getting-started.md Use npx create-next-app@latest instead of the version that is installed (#29595) 2021-10-04 11:13:45 +02:00
going-to-production.md Update Going to Production docs to use quote. (#27131) 2021-07-12 23:13:52 +00:00
manifest.json [Docs] Add testing docs (#27965) 2021-08-11 20:47:12 +00:00
testing.md Use npx create-next-app@latest instead of the version that is installed (#29595) 2021-10-04 11:13:45 +02:00
upgrading.md Mention customization of next.config.js to import images (#27104) 2021-07-12 13:16:13 +00:00