I'm creating this issue to talk about normalizing all our error messages to systematically have a link to a docs.
Force link
[ ] Eslint rule to force a link
Examples:
Next.js. Their "Head of DevEx" created this PR: https://github.com/vercel/next.js/pull/34335 which seems to be great.
However, it feels wrong to force custom pages for every error. You can have a permalink (/r/ URLs) instead for this, as well as trivial errors that don't need a docs page. So our policy could be to either have docs about the error, or a custom pages, e.g. https://nextjs.org/docs/messages/get-initial-props-export or nothing if trivial.
Summary
I'm creating this issue to talk about normalizing all our error messages to systematically have a link to a docs.
Force link
Examples:
/r/
URLs) instead for this, as well as trivial errors that don't need a docs page. So our policy could be to either have docs about the error, or a custom pages, e.g. https://nextjs.org/docs/messages/get-initial-props-export or nothing if trivial.Force permalink
Examples:
https://nextjs.org/docs/messages/
. https://github.com/search?q=repo%3Avercel%2Fnext.js+%22const+url+%3D+%27https%3A%2F%2F%22&type=code&p=2No response
Search keywords: -