Create a page with error codes
Maintainers usually reply within 2 days
Nobody has claimed this yet.
Assessment
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Newbie friendliness
- 48/100
- Issue type
- Documentation
- Clarity
- Mostly clear
- Activity status
- Stale
- Tech stack
- node.js
- Domain
- documentation
Research direction
No documentation page or file is specified, so first inspect the documentation structure and locate the appropriate page for error references. Compile the meaningful Harper error.name values, link the Node.js error.code documentation already cited, and document the relevant HTTP status codes and standards; done means all three error sources are clearly listed and explained.
Written by the indexing model from the issue text.
Description
Request Type
Undocumented existing feature
What needs to be documented?
There are several different error codes that can potentially be informative:
-
In Harper, we identify and distinguish known types or classes following standard best practice of using identifiable Error constructor names. Programmatically, this available in the error.name property. In logs, this appears as ErrorInCamelCase: ... stack trace ...
We should put together a list of known meaningful error constructor names in the page here. -
Node.js error codes. These are available from the error.code property and are “yelled” in logs as ERR_SOME_NODE_ERROR_CODE. We can link to the list of error codes here: Errors | Node.js v25.1.0 Documentation
-
We also report errors from our endpoints using HTTP status codes. We try to follow standards for the appropriate error code (link to HTTP specs).
Where should this be documented?
No response
Why is this needed?
No response
Existing information
No response
Priority/Impact
Medium - important but not urgent
Are you planning to fix this issue?
No, just reporting the issue
First-time contributor support
- I'm new to contributing and would appreciate guidance on the process
- I'd like help understanding the project structure
- I need assistance with setting up the development environment
- I'm comfortable contributing but new to this project specifically
- Dominant language
- MDX
- Stars
- 9
- Forks
- 9
- Avg merge
- 1d 20h
- Merged PRs (30d)
- 16
Getting set up
- No Dockerfile or Docker Compose file
- No pull request template
- Read the contributing guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
More from HarperFast/documentation
-
Difficulty 1/5 Under an hour Newbie friendliness 90/100
HarperFast/documentation#690 ·
Maintainers usually reply within 2 days
-
Difficulty 2/5 1-3 hours Newbie friendliness 72/100
HarperFast/documentation#677 ·
Maintainers usually reply within 2 days
-
Difficulty 2/5 Half a day Newbie friendliness 88/100
HarperFast/documentation#675 ·
Maintainers usually reply within 2 days
-
Difficulty 1/5 Under an hour Newbie friendliness 92/100
HarperFast/documentation#665 ·
Maintainers usually reply within 2 days
-
content
Difficulty 2/5 1-3 hours Newbie friendliness 74/100
HarperFast/documentation#478 ·
Maintainers usually reply within 2 days
All issues in HarperFast/documentation
Similar issues
-
bug
Difficulty 2/5 1-3 hours Newbie friendliness 88/100
MystenLabs/MemWal#1085 · 1 comment ·
Maintainers usually reply within 1 day
-
📕documentation
Difficulty 2/5 1-3 hours Newbie friendliness 72/100
db-ux-design-system/core-web#8343 ·
Maintainers usually reply within 1 day
-
enhancement triage/needs-triage
Difficulty 2/5 1-3 hours Newbie friendliness 88/100
heygen-com/hyperframes#4944 ·
Maintainers usually reply within 1 day
-
Difficulty 2/5 1-3 hours Newbie friendliness 78/100
Maintainers usually reply within 1 day
-
Difficulty 2/5 1-3 hours Newbie friendliness 78/100
Maintainers usually reply within 1 day