Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Overhaul image component documentation #29186

Merged
merged 52 commits into from
Oct 5, 2021

Conversation

atcastle
Copy link
Collaborator

@atcastle atcastle commented Sep 17, 2021

This PR contains an overhaul of the image component documentation for next (both the primary usage doc and the API reference). 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

@ijjk ijjk added created-by: Chrome Aurora PRs by the Google Chrome team: https://web.dev/aurora type: documentation labels Sep 17, 2021
@styfle styfle marked this pull request as draft September 17, 2021 20:16
Co-authored-by: Steven <steven@ceriously.com>
Copy link
Member

@styfle styfle left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Let's use Image Optimization API

docs/api-reference/next/image.md Outdated Show resolved Hide resolved
docs/basic-features/image-optimization.md Outdated Show resolved Hide resolved
docs/basic-features/image-optimization.md Outdated Show resolved Hide resolved
docs/basic-features/image-optimization.md Outdated Show resolved Hide resolved
docs/api-reference/next/image.md Outdated Show resolved Hide resolved
docs/api-reference/next/image.md Outdated Show resolved Hide resolved
docs/api-reference/next/image.md Outdated Show resolved Hide resolved
docs/api-reference/next/image.md Outdated Show resolved Hide resolved
docs/api-reference/next/image.md Outdated Show resolved Hide resolved
docs/api-reference/next/image.md Outdated Show resolved Hide resolved
docs/api-reference/next/image.md Outdated Show resolved Hide resolved
docs/api-reference/next/image.md Outdated Show resolved Hide resolved
docs/api-reference/next/image.md Outdated Show resolved Hide resolved
docs/api-reference/next/image.md Outdated Show resolved Hide resolved
docs/api-reference/next/image.md Outdated Show resolved Hide resolved
docs/api-reference/next/image.md Outdated Show resolved Hide resolved
docs/api-reference/next/image.md Outdated Show resolved Hide resolved
docs/basic-features/image-optimization.md Outdated Show resolved Hide resolved
docs/basic-features/image-optimization.md Outdated Show resolved Hide resolved
docs/basic-features/image-optimization.md Outdated Show resolved Hide resolved
docs/basic-features/image-optimization.md Outdated Show resolved Hide resolved
docs/basic-features/image-optimization.md Outdated Show resolved Hide resolved
docs/basic-features/image-optimization.md Outdated Show resolved Hide resolved
docs/basic-features/image-optimization.md Outdated Show resolved Hide resolved
atcastle and others added 13 commits September 17, 2021 14:27
Co-authored-by: Lee Robinson <me@leerob.io>
Co-authored-by: Lee Robinson <me@leerob.io>
Co-authored-by: Lee Robinson <me@leerob.io>
Co-authored-by: Lee Robinson <me@leerob.io>
Co-authored-by: Lee Robinson <me@leerob.io>
Co-authored-by: Lee Robinson <me@leerob.io>
Co-authored-by: Lee Robinson <me@leerob.io>
Co-authored-by: Lee Robinson <me@leerob.io>
Co-authored-by: Lee Robinson <me@leerob.io>
Co-authored-by: Lee Robinson <me@leerob.io>
Co-authored-by: Lee Robinson <me@leerob.io>
Co-authored-by: Lee Robinson <me@leerob.io>
Co-authored-by: Lee Robinson <me@leerob.io>
styfle
styfle previously approved these changes Sep 29, 2021
Copy link
Member

@styfle styfle left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good, just need to add redirects so that we don't break existing URLs (imagine someone linking to the Next.js docs)

@styfle styfle changed the title [DRAFT] Overhaul image component documentation Overhaul image component documentation Oct 5, 2021
leerob
leerob previously approved these changes Oct 5, 2021
@styfle styfle marked this pull request as ready for review October 5, 2021 19:54
styfle
styfle previously approved these changes Oct 5, 2021
@kodiakhq kodiakhq bot merged commit 5d7b68f into vercel:canary Oct 5, 2021
@vercel vercel locked as resolved and limited conversation to collaborators Jan 27, 2022
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
created-by: Chrome Aurora PRs by the Google Chrome team: https://web.dev/aurora
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Improve documentation for custom loaders in image component
7 participants