add info on how to submit docs patch #4591
Conversation
|
LGTM (again, tho, the commit log would need to be updated to conform to the style guideline :-) ...) |
|
oh dang. OK well I'll wait if they all LG then I'll amend & overwrite. |
|
No worries, it can also be fixed by whoever lands the PR. Just something to keep in mind for next time :-) Thank you for the contributions! |
Sequoia
force-pushed
the
link-to-repo-in-docs
branch
from
a63c6ed
to
1d3e865
Compare
|
updated commit message to bring into compliance. |
|
Might be awesome if the contributing guide were mentioned. I know that for me I didn't know it existed before I submitted my first pull request. |
|
@Sequoia wanna update to just link to CONTRIBUTING.md? |
Sequoia
force-pushed
the
link-to-repo-in-docs
branch
from
1d3e865
to
0fc8545
Compare
|
@silverwind updated. |
|
LGTM |
|
|
||
| If you find a error in this documentation, please | ||
| [submit an issue](https://github.com/nodejs/node/issues/new), | ||
| or see [the contributing guide](https://github.com/nodejs/node/blob/master/CONTRIBUTING.md) |
There was a problem hiding this comment.
the links here can actually be moved to the end of the document... in-line simply do [submit an issue][] and [the contributing guide][], then at the bottom of the documentation.markdown file, add:
[submit an issue]: https://github.com/nodejs/node/issues/new
[the contributing guide]: https://github.com/nodejs/node/blob/master/CONTRIBUTING.md
doing so would ensure that the text itself will line wrap correctly and will be easier to read later if changes need to be made.
|
LGTM with a nit |
The docs mentioned that the docs source live in the node source, but did not link to same.
Sequoia
force-pushed
the
link-to-repo-in-docs
branch
from
0fc8545
to
fa78ce6
Compare
|
@jasnell updated |
|
LGTM |
The docs mentioned that the docs source live in the node source, but did not link to same. PR-URL: #4591 Reviewed-By: Roman Reiss <me@silverwind.io> Reviewed-By: James M Snell <jasnell@gmail.com>
|
Landed in 1d9a2b2 |
The docs mentioned that the docs source live in the node source, but did not link to same. PR-URL: #4591 Reviewed-By: Roman Reiss <me@silverwind.io> Reviewed-By: James M Snell <jasnell@gmail.com>
The docs mentioned that the docs source live in the node source, but did not link to same. PR-URL: #4591 Reviewed-By: Roman Reiss <me@silverwind.io> Reviewed-By: James M Snell <jasnell@gmail.com>
The docs mentioned that the docs source live in the node source, but did not link to same. PR-URL: #4591 Reviewed-By: Roman Reiss <me@silverwind.io> Reviewed-By: James M Snell <jasnell@gmail.com>
The docs mentioned that the docs source live in the node source, but did not link to same. PR-URL: #4591 Reviewed-By: Roman Reiss <me@silverwind.io> Reviewed-By: James M Snell <jasnell@gmail.com>
"About this documentation" said docs were in the node source but didn't link to them or mention how to report an issue.