-
-
Notifications
You must be signed in to change notification settings - Fork 2.2k
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
docs: align errors and warning docs #5142
Comments
I am -1 for this. |
I think the current doc is mirroring https://nodejs.org/dist/latest-v20.x/docs/api/errors.html#nodejs-error-codes The difference is we don't have an in-page table-of-contents like they do. See top of https://nodejs.org/dist/latest-v20.x/docs/api/errors.html I'm really not sure what would be better. An example shown here would help. |
@jsumners you mean an example of what I'm proposing?
I like the idea of mirroring nodejs-error-codes, but I don't think it's a constraint to be strictly followed: I'm quite sure a table representation would improve readability a lot. |
I dislike the idea of a table structure. |
And if we have to link to a discussion/issue then the documentation wont be self contained. |
I'm good with the suggestion. It would make things more legible. But each row should have an anchor so that errors can easily be linked. @fastify/core ? |
I think a link does not hurt and Google+SEO will help someone during the debug |
Structure LGTM, just wondering about what are the exact intentions with the |
I was thinking to add the PR in which we add that specific error code |
Prerequisites
Issue
Recently we added the
docs/Reference/Warnings.md
to better document all the warnings emitted by Fastify. To do that, we used tables in the formatIn the
docs/Reference/Errors.md
instead we list all the errors with a short description.What do you think about aligning the style of the two pages by using a similar table for the errors? Maybe it could not be possible to write the
How to solve
column for all of the errors, but it could make the page more readable.The text was updated successfully, but these errors were encountered: