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鈥檒l occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs(guides/single-fetch): add some recommended steps #9534

Merged
merged 10 commits into from
Jun 6, 2024

Conversation

michenly
Copy link
Contributor

Some recommended docs changes.

Feel free to edit on top of if as you see fix 馃檹

Copy link

changeset-bot bot commented May 31, 2024

鈿狅笍 No Changeset found

Latest commit: d0e4da4

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

@remix-cla-bot
Copy link
Contributor

remix-cla-bot bot commented May 31, 2024

Hi @michenly,

Welcome, and thank you for contributing to Remix!

Before we consider your pull request, we ask that you sign our Contributor License Agreement (CLA). We require this only once.

You may review the CLA and sign it by adding your name to contributors.yml.

Once the CLA is signed, the CLA Signed label will be added to the pull request.

If you have already signed the CLA and received this response in error, or if you have any questions, please contact us at hello@remix.run.

Thanks!

- The Remix team

@remix-cla-bot
Copy link
Contributor

remix-cla-bot bot commented May 31, 2024

Thank you for signing the Contributor License Agreement. Let's get this merged! 馃コ

@MichaelDeBoey MichaelDeBoey changed the title docs: update single-fetch.md with some recommended steps docs(guides/single)fetch): add some recommended steps Jun 3, 2024
@MichaelDeBoey MichaelDeBoey changed the title docs(guides/single)fetch): add some recommended steps docs(guides/single-fetch): add some recommended steps Jun 3, 2024
@brookslybrand
Copy link
Contributor

Thank you @michenly!


Please also read through the [Breaking Changes][breaking-changes] before starting so you can be aware of some of the underlying behavior changes, specifically around serialization and status/header behavior.

## Breaking Changes
Copy link
Contributor

Choose a reason for hiding this comment

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

I worry putting this section first will give the wrong impression - that folks need to make all these changes before they can enable single fetch because the order in which they'll read the doc is Breaking Changes -> Enabling.

Technically, I think the only thing they need to do to start using it is the fetch polyfill update. the rest of the "breaking changes" should be almost 100% backwards compatible and able to fixed incrementally after enabling the feature.

Copy link
Contributor

Choose a reason for hiding this comment

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

Yeah, that's a good point, I agree. It also follows the flow in the overview

Remix introduced support for "Single Fetch"...

Enabling Single Fetch is incredibly simple...

Please also read through the Breaking Changes...

Copy link
Contributor

Choose a reason for hiding this comment

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

Technically, I think the only thing they need to do to start using it is the fetch polyfill update. the rest of the "breaking changes" should be almost 100% backwards compatible and able to fixed incrementally after enabling the feature.

I agree, it's more about awareness of how it's effecting your code. The "Deprecated headers export" might be the only exception. You're right, it's not breaking, but if people are heavily using a CDN it's good to know how Single Fetch effects that piece.

Copy link
Contributor

Choose a reason for hiding this comment

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

ah yeah good call - headers also needs to be updated to adopt

Copy link
Contributor

Choose a reason for hiding this comment

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

Maybe we can more clearly delineate the breaking changes as "up front" and "iteratively after the fact"

Copy link
Contributor Author

@michenly michenly Jun 4, 2024

Choose a reason for hiding this comment

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

If there is a concern I am 馃憤 with moving the block down. I originally move it up because the overview made a point of reading through underline changes and it had made sense to me that folk should understand what had really changed under the hood before using it.

Copy link
Contributor

Choose a reason for hiding this comment

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

I can take a stab at this sometime today

Copy link
Contributor

@brophdawg11 brophdawg11 left a comment

Choose a reason for hiding this comment

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

OK, I moved the breaking changes section back below and separated them by "up front" and "over time". Let me know if there's any last feedback and I'll get this merged today! Thanks!

@brophdawg11 brophdawg11 self-assigned this Jun 5, 2024
@brophdawg11 brophdawg11 merged commit c1220a4 into remix-run:main Jun 6, 2024
2 checks passed
@michenly michenly deleted the patch-1 branch June 7, 2024 14:12
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants