restify / restify/node-restify
Mistakes in the Documentation
Nobody has claimed this yet.
- Dominant language
- JavaScript
- Stars
- 10.7k
- Forks
- 975
- Avg merge
- 1d 6h
- Merged PRs (30d)
- 5
Description
Hello and sorry if this is the wrong place to post this but I've just went through the restify Quick Start Guide and there where two mistakes:
-
The RegExp Examples don't work with higher versions than restify 6.x. This is very confusing and frustrating for a beginner.
There was no hint in the Guide for that! -
In the first Examples restify-errors are written "restify.errors". (in the first example: "var err = new restify.errors.NotFoundError('oh noes!');" )
This throws an error until you correct it to "var err = new restify-errors.NotFoundError('oh noes!')"
I've lost a lot of time trying to get make this work and it would be great if you could correct these mistakes for the next beginners to do the Tutorial!
Greetings
Contributor 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.
Research direction
Locate the Quick Start Guide in the repository and review the RegExp examples and the first error-handling example. Verify the examples against current restify versions, then update the guide so the RegExp limitation is explained and the error example uses the correct restify-errors reference.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- javascript, node.js
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Clearly specified
- Newbie friendliness
- 45/100