Skip to content
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.

Sign up for GitHub

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

Jump to bottom

Add supported Node.js versions in latest Docs #6470

Closed
PatrickHeneise opened this issue Apr 29, 2016 · 4 comments
Closed

Add supported Node.js versions in latest Docs #6470

PatrickHeneise opened this issue Apr 29, 2016 · 4 comments
Labels
doc Issues and PRs related to the documentations. duplicate Issues and PRs that are duplicates of other issues or PRs.

Comments

@PatrickHeneise
Copy link

  • Version: 6

Search engines usually show the latest docs for Node.js. Today I had the frustrating task to debug why my Buffer.from(string, encoding) function worked perfectly fine on my developer machine but threw a TypeError 'binary' is not a function. It took me a while to realise I'm running Node 4 LTS on staging and of course Node 6 on the dev machine and that Buffer.from is not working in 4 LTS, but already deprecated in 6. Worse is that Buffer.from() should have thrown the non-existing function error, as it's not listed in the v4 docs.

I think it would be great help to have the supported versions for each function in the latest documentation to see when a function has been introduced and when it gets deprecated, best with colours ranging from green, orange and red (just an idea), to indicate right away the status.
@mscdex mscdex added the doc Issues and PRs related to the documentations. label Apr 29, 2016
@cjihrig
Copy link
Contributor

cjihrig commented Apr 29, 2016

cc: @nodejs/documentation

@jasnell
Copy link
Member

jasnell commented Apr 29, 2016

There was a previous effort to do this that stalled out because the person working on it ended up getting busy on other work. Would love to see this revisited.

@addaleax
Copy link
Member

There’s #3713 and the doctool support PR in #3867. I’ve asked to rebase the latter one because I’d love to work on this, but no response so far.

@addaleax addaleax added the duplicate Issues and PRs that are duplicates of other issues or PRs. label May 1, 2016
@addaleax
Copy link
Member

addaleax commented May 1, 2016 •
edited
Loading

Closing this as a duplicate of #3713, and I’m working on this in #6495.

@addaleax addaleax closed this as completed May 1, 2016
@addaleax addaleax mentioned this issue May 1, 2016
Closed
4 tasks
addaleax pushed a commit to addaleax/node that referenced this issue May 4, 2016
@tflanagan @addaleax
tools: parse documentation metadata
7ee6bd1 
This commit introduces the Documentation YAML metadata concept to the
documentation.

- Parses added or Added for HTML
- Parses all data for JSON

Ref: nodejs#3713
Ref: nodejs#6470
addaleax pushed a commit that referenced this issue May 4, 2016
@tflanagan @addaleax
tools: parse documentation metadata
015f4fd 
This commit introduces the Documentation YAML metadata concept to the
documentation.

- Parses added or Added for HTML
- Parses all data for JSON

Ref: #3867
Ref: #3713
Ref: #6470
PR-URL: #6495
Reviewed-By: Robert Jefe Lindstaedt <robert.lindstaedt@gmail.com>
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Jeremiah Senkpiel <fishrock123@rocketmail.com>
evanlucas pushed a commit that referenced this issue May 17, 2016
@tflanagan @evanlucas
tools: parse documentation metadata
cea1777 
This commit introduces the Documentation YAML metadata concept to the
documentation.

- Parses added or Added for HTML
- Parses all data for JSON

Ref: #3867
Ref: #3713
Ref: #6470
PR-URL: #6495
Reviewed-By: Robert Jefe Lindstaedt <robert.lindstaedt@gmail.com>
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Jeremiah Senkpiel <fishrock123@rocketmail.com>
addaleax pushed a commit to addaleax/node that referenced this issue Jul 12, 2016
@tflanagan @addaleax
tools: parse documentation metadata
f6b5db6 
This commit introduces the Documentation YAML metadata concept to the
documentation.

- Parses added or Added for HTML
- Parses all data for JSON

Ref: nodejs#3867
Ref: nodejs#3713
Ref: nodejs#6470
PR-URL: nodejs#6495
Reviewed-By: Robert Jefe Lindstaedt <robert.lindstaedt@gmail.com>
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Jeremiah Senkpiel <fishrock123@rocketmail.com>
MylesBorins pushed a commit that referenced this issue Jul 12, 2016
@tflanagan
tools: parse documentation metadata
f49158a 
This commit introduces the Documentation YAML metadata concept to the
documentation.

- Parses added or Added for HTML
- Parses all data for JSON

Ref: #3867
Ref: #3713
Ref: #6470
PR-URL: #6495
Reviewed-By: Robert Jefe Lindstaedt <robert.lindstaedt@gmail.com>
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Jeremiah Senkpiel <fishrock123@rocketmail.com>
MylesBorins pushed a commit that referenced this issue Jul 14, 2016
@tflanagan
tools: parse documentation metadata
f0f990a 
This commit introduces the Documentation YAML metadata concept to the
documentation.

- Parses added or Added for HTML
- Parses all data for JSON

Ref: #3867
Ref: #3713
Ref: #6470
PR-URL: #6495
Reviewed-By: Robert Jefe Lindstaedt <robert.lindstaedt@gmail.com>
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Jeremiah Senkpiel <fishrock123@rocketmail.com>
MylesBorins pushed a commit that referenced this issue Jul 14, 2016
@tflanagan
tools: parse documentation metadata
2832a60 
This commit introduces the Documentation YAML metadata concept to the
documentation.

- Parses added or Added for HTML
- Parses all data for JSON

Ref: #3867
Ref: #3713
Ref: #6470
PR-URL: #6495
Reviewed-By: Robert Jefe Lindstaedt <robert.lindstaedt@gmail.com>
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Jeremiah Senkpiel <fishrock123@rocketmail.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
doc Issues and PRs related to the documentations. duplicate Issues and PRs that are duplicates of other issues or PRs.
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
5 participants
@mscdex @PatrickHeneise @jasnell @addaleax @cjihrig