Repository navigation
Order docs alphabetically #393
Description
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.
Activity
brendanashworth commentedon Jan 22, 2015
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 commentedon Jan 22, 2015
Cool. Well #553 is my first step to see if anyone else is interested.
doc: alphabetize all.markdown
robertkowalski commentedon Mar 1, 2015
@MattMS I think this got merged and we can close it, right?
brendanashworth commentedon Mar 1, 2015
@robertkowalski the pull request where the change was proposed was closed in favor of waiting how things go forward in joyent/node
MattMS commentedon Mar 1, 2015
From #740 it sounds like (the idea of) #553 would be fine now, right?
robertkowalski commentedon Mar 1, 2015
@MattMS @brendanashworth hmm... I don't see a PR at joyent/node...
@MattMS I think you are probably right that as #740 landed docs will be hard to merge anyway. @brendanashworth what do you think?
rvagg commentedon 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 commentedon 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 commentedon Mar 1, 2015
I am also +1 and would merge tomorrow if no one objects
MattMS commentedon 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.
Fishrock123 commentedon Jun 24, 2015
@chrisdickinson could you take this up to discuss in the docs WG?
Fishrock123 commentedon Jul 28, 2015
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 commentedon Jul 28, 2015
Formal +1
Qard commentedon Aug 14, 2015
👍 from me too.
MattMS commentedon Aug 18, 2015
Should I redo #553 with the current docs?
Fishrock123 commentedon Aug 18, 2015
@MattMS Sure! :)
sam-github commentedon Aug 19, 2015
+1
MattMS commentedon Aug 19, 2015
Pull request for reordered fs at #2432
MattMS commentedon Sep 11, 2015
I closed #2432 to wait for further discussion and confirmation on the best ordering/grouping to use.
brendanashworth commentedon Sep 15, 2015
Ref to nodejs/doc-tool#3 (comment).
tflanagan commentedon Nov 13, 2015
This can be closed now! :)
jasnell commentedon Nov 13, 2015
Thank you @tflanagan for doing the work!