Clarify not supported Next.js features #4266
Conversation
iker-barriocanal
requested review from
rhcarvalho and
smeubank
and removed request for
a team
|
This pull request is being automatically deployed with Vercel (learn more). 🔍 Inspect: https://vercel.com/sentry/sentry-docs/31vUMNTzGh461QfhEcVABWyxSJva |
|
What's the actual state of supporting this? I've seen this comment from @lobsterkatie that states it should mostly work - getsentry/sentry-javascript#3782 (comment) |
|
At the moment, not planned. There's this new issue related to it too. |
| @@ -15,3 +15,4 @@ Features: | |||
| - Automatic [Performance Monitoring](/product/performance/) for both the client and server, from version `6.5.0` | |||
|
|
|||
| Under the hood the SDK relies on our [React SDK](/platforms/javascript/guides/react/) on the frontend and [Node SDK](/platforms/node) on the backend, which makes all features available in those SDKs also available in this SDK. | |||
| However, some Next.js features aren't currently supported, such as using a [custom server](https://nextjs.org/docs/advanced-features/custom-server). | |||
There was a problem hiding this comment.
Not sure if this is the best place to put this - considering the sentences above are referring to sdk features.
There was a problem hiding this comment.
I think this placement is fine, but we shouldn't have a lead-in sentence saying "some" features aren't supported and then only name one feature. Suggest the following edit:
| However, some Next.js features aren't currently supported, such as using a [custom server](https://nextjs.org/docs/advanced-features/custom-server). | |
| However, using a [custom server](https://nextjs.org/docs/advanced-features/custom-server) is not currently supported. |
There was a problem hiding this comment.
Applied the changes. How should we proceed as the list grows?
There was a problem hiding this comment.
When there's more than one item in this list, then I think we should take out the sentence we've added and replace it with a list like the Features list that's called "Not Currently Supported". I have to review the other SDK docs to confirm we don't already have a solution for this problem though.
There was a problem hiding this comment.
I checked through the SDK docs and we don't have another method for documenting unsupported features that I could find, so going forward, when we have more than one unsupported feature, use the solution that I've proposed above.
| @@ -15,3 +15,4 @@ Features: | |||
| - Automatic [Performance Monitoring](/product/performance/) for both the client and server, from version `6.5.0` | |||
|
|
|||
| Under the hood the SDK relies on our [React SDK](/platforms/javascript/guides/react/) on the frontend and [Node SDK](/platforms/node) on the backend, which makes all features available in those SDKs also available in this SDK. | |||
| However, some Next.js features aren't currently supported, such as using a [custom server](https://nextjs.org/docs/advanced-features/custom-server). | |||
There was a problem hiding this comment.
I think this placement is fine, but we shouldn't have a lead-in sentence saying "some" features aren't supported and then only name one feature. Suggest the following edit:
| However, some Next.js features aren't currently supported, such as using a [custom server](https://nextjs.org/docs/advanced-features/custom-server). | |
| However, using a [custom server](https://nextjs.org/docs/advanced-features/custom-server) is not currently supported. |
We should add to the docs the Next.js features we don't support. I'm not sure what the best place is, so I've added it in the paragraph after the features in the getting started page (see picture below). If the set of unsupported features grows, we can make an actual list, make another paragraph, add a section... If you can think of any other place where this section may suit better, please suggest.