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

Order docs alphabetically #393

Closed
MattMS opened this issue Jan 14, 2015 · 22 comments
Closed

Order docs alphabetically #393

MattMS opened this issue Jan 14, 2015 · 22 comments
Labels
doc Issues and PRs related to the documentations. good first issue Issues that are suitable for first-time contributors.

Comments

@MattMS
Copy link

MattMS commented Jan 14, 2015

Would it be possible to have the docs Markdown files ordered alphabetically to make it easier to use as a reference?

I am happy to do work towards this but I am not familiar enough with the documentation process to know if there would be any side-effects, such as with the JSON output.
@brendanashworth
Copy link
Contributor

A little bit trivial, but it doesn't make any sense to have the list in alphabetical order but the all page be in... seemingly random order. I don't think there'd be any side effects to this, @MattMS.

👍

@MattMS
Copy link
Author

MattMS commented Jan 22, 2015

Cool. Well #553 is my first step to see if anyone else is interested.

@Fishrock123 Fishrock123 added the doc Issues and PRs related to the documentations. label Jan 22, 2015
brendanashworth added a commit to brendanashworth/io.js that referenced this issue Jan 23, 2015
@brendanashworth
doc: alphabetize all.markdown
8e87375 
Previously the order made no sense, especially since `toc.markdown` was
alphabetized but `all.markdown` was not.

This might fix issue nodejs#393 but after PR nodejs#553, I don't think we're on the
same page.
@brendanashworth brendanashworth mentioned this issue Jan 23, 2015
Closed
@Fishrock123 Fishrock123 added discuss Issues opened for discussions and feedbacks. ideas and removed ideas labels Jan 30, 2015
@MattMS MattMS mentioned this issue Jan 31, 2015
Closed
@Fishrock123 Fishrock123 mentioned this issue Feb 7, 2015
Closed
@robertkowalski
Copy link
Contributor

@MattMS I think this got merged and we can close it, right?

@brendanashworth
Copy link
Contributor

@robertkowalski the pull request where the change was proposed was closed in favor of waiting how things go forward in joyent/node

@MattMS
Copy link
Author

MattMS commented Mar 1, 2015

From #740 it sounds like (the idea of) #553 would be fine now, right?

@robertkowalski
Copy link
Contributor

@robertkowalski the pull request where the change was proposed was closed in favor of waiting how things go forward in joyent/node

@MattMS @brendanashworth hmm... I don't see a PR at joyent/node...

From #740 it sounds like (the idea of) #553 would be fine now, right?

@MattMS I think you are probably right that as #740 landed docs will be hard to merge anyway. @brendanashworth what do you think?

@rvagg
Copy link
Member

rvagg commented Mar 1, 2015

I'm +1 on just pushing ahead with improving docs even if it means making it hard to merge stuff. In reality, there's not a whole lot of docs work going on in joyent/node, most of it is happening here. The improved docs situation here is a benefit to the whole community. node-forward y'all.

@tellnes
Copy link
Contributor

tellnes commented Mar 1, 2015

+1 what @rvagg.

There is already so much changes to the docs anyway, so this will probably only be one of many problems if you wants to merge those branches.

@robertkowalski
Copy link
Contributor

I am also +1 and would merge tomorrow if no one objects

@MattMS
Copy link
Author

MattMS commented Mar 2, 2015

All sounds great to me 😄

I'm happy to spend some time reordering docs and making PRs referenced here.
It'll be in a few hours though, after I finish work.

@brendanashworth brendanashworth added good first issue Issues that are suitable for first-time contributors. and removed discuss Issues opened for discussions and feedbacks. labels Jun 8, 2015
@Fishrock123
Copy link
Contributor

@chrisdickinson could you take this up to discuss in the docs WG?

@brendanashworth brendanashworth mentioned this issue Jul 28, 2015
Closed
@Fishrock123
Copy link
Contributor

Ok so, the main concern here was that we'd have conflicts pulling over joyent/node doc changes.

Since we are now the authoritative source, it's not really an issue anymore. I think we should go ahead with this.

cc @nodejs/documentation

@thefourtheye
Copy link
Contributor

Formal +1

@Qard
Copy link
Member

Qard commented Aug 14, 2015

👍 from me too.

@MattMS
Copy link
Author

MattMS commented Aug 18, 2015

Should I redo #553 with the current docs?

@Fishrock123
Copy link
Contributor

@MattMS Sure! :)

@sam-github
Copy link
Contributor

+1

@MattMS
Copy link
Author

MattMS commented Aug 19, 2015

Pull request for reordered fs at #2432

@MattMS MattMS mentioned this issue Sep 11, 2015
Closed
@MattMS
Copy link
Author

MattMS commented Sep 11, 2015

I closed #2432 to wait for further discussion and confirmation on the best ordering/grouping to use.

@brendanashworth
Copy link
Contributor

Ref to nodejs/doc-tool#3 (comment).

@Trott Trott mentioned this issue Nov 3, 2015
Closed
This was referenced Nov 4, 2015
Closed
Closed
@tflanagan
Copy link
Contributor

This can be closed now! :)

@jasnell jasnell closed this as completed Nov 13, 2015
@jasnell
Copy link
Member

jasnell commented Nov 13, 2015

Thank you @tflanagan for doing the work!

@NOUIY NOUIY mentioned this issue Sep 10, 2022
Open
This was referenced Oct 4, 2022
Open
Open
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. good first issue Issues that are suitable for first-time contributors.
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests