-
Notifications
You must be signed in to change notification settings - Fork 29.8k
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.
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
doc/markdown file organization lacks coherence #31741
Comments
and merge with |
I'd like to take this issue, if that's ok |
Go for it! |
DavenportEmma
added a commit
to DavenportEmma/node
that referenced
this issue
Feb 13, 2020
Merged the CODE_OF_CONDUCT.md and doc/guides/contributing/coc.md files into a single code of conduct file Refs: nodejs#31741
DavenportEmma
added a commit
to DavenportEmma/node
that referenced
this issue
Feb 13, 2020
Changed security_release_process.md to security-release-process.md to stay consistent with file naming Refs: nodejs#31741
DavenportEmma
added a commit
to DavenportEmma/node
that referenced
this issue
Feb 13, 2020
Moved writing-and-running-benchmarks to doc/guides/ directory Fixes: nodejs#31741
DavenportEmma
added a commit
to DavenportEmma/node
that referenced
this issue
Feb 13, 2020
Updated updating-root-certs.md to maintaining-root-certs.md Fixes: nodejs#31741
DavenportEmma
added a commit
to DavenportEmma/node
that referenced
this issue
Feb 13, 2020
Moved COLLABORATOR_GUIDE, CPP_STYLE_GUIDE, and internal-api to the appropriate directories Fixes: nodejs#31741
DavenportEmma
added a commit
to DavenportEmma/node
that referenced
this issue
Feb 13, 2020
DavenportEmma
added a commit
to DavenportEmma/node
that referenced
this issue
Feb 13, 2020
Moved STYLE_GUIDE.md to guides/documentation-style.md Fixes: nodejs#31741
3 tasks
DavenportEmma
added a commit
to DavenportEmma/node
that referenced
this issue
Feb 14, 2020
Merged the CODE_OF_CONDUCT.md and doc/guides/contributing/coc.md files into a single code of conduct file Refs: nodejs#31741
DavenportEmma
added a commit
to DavenportEmma/node
that referenced
this issue
Feb 14, 2020
Changed security_release_process.md to security-release-process.md to stay consistent with file naming Refs: nodejs#31741
DavenportEmma
added a commit
to DavenportEmma/node
that referenced
this issue
Feb 14, 2020
Moved writing-and-running-benchmarks to doc/guides/ directory Fixes: nodejs#31741
DavenportEmma
added a commit
to DavenportEmma/node
that referenced
this issue
Feb 14, 2020
Updated updating-root-certs.md to maintaining-root-certs.md Fixes: nodejs#31741
DavenportEmma
added a commit
to DavenportEmma/node
that referenced
this issue
Feb 14, 2020
Moved COLLABORATOR_GUIDE, CPP_STYLE_GUIDE, and internal-api to the appropriate directories Fixes: nodejs#31741
DavenportEmma
added a commit
to DavenportEmma/node
that referenced
this issue
Feb 14, 2020
DavenportEmma
added a commit
to DavenportEmma/node
that referenced
this issue
Feb 14, 2020
Moved STYLE_GUIDE.md to guides/documentation-style.md Fixes: nodejs#31741
4 tasks
DavenportEmma
added a commit
to DavenportEmma/node
that referenced
this issue
Feb 27, 2020
Updated cpp style guide file name and location and fixed links to this file. Fixes: nodejs#31741
DavenportEmma
added a commit
to DavenportEmma/node
that referenced
this issue
Feb 27, 2020
Updated collaborator guide file name and location and fixed links to this file. Fixes: nodejs#31741
DavenportEmma
added a commit
to DavenportEmma/node
that referenced
this issue
Feb 27, 2020
Updated documentation style guide file name and location and updated links referencing the file. Fixes: nodejs#31741
DavenportEmma
added a commit
to DavenportEmma/node
that referenced
this issue
Feb 27, 2020
Fixed the links referencing markdown files that have moved location Fixes: nodejs#31741
DavenportEmma
added a commit
to DavenportEmma/node
that referenced
this issue
Feb 27, 2020
Moved files to appropriate location and updated naming style for some of them. Fixes: nodejs#31741
MylesBorins
pushed a commit
that referenced
this issue
Mar 4, 2020
* Updated cpp style guide file name and location and fixed links to this file. * Updated collaborator guide file name and location and fixed links to this file. * Updated documentation style guide file name and location and updated links referencing the file. * Moved files to appropriate location and updated naming style for some of them. Fixes: #31741 PR-URL: #31792 Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Sam Roberts <vieuxtech@gmail.com>
codebytere
pushed a commit
that referenced
this issue
Mar 16, 2020
* Updated cpp style guide file name and location and fixed links to this file. * Updated collaborator guide file name and location and fixed links to this file. * Updated documentation style guide file name and location and updated links referencing the file. * Moved files to appropriate location and updated naming style for some of them. Fixes: #31741 PR-URL: #31792 Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Sam Roberts <vieuxtech@gmail.com>
codebytere
pushed a commit
that referenced
this issue
Mar 17, 2020
* Updated cpp style guide file name and location and fixed links to this file. * Updated collaborator guide file name and location and fixed links to this file. * Updated documentation style guide file name and location and updated links referencing the file. * Moved files to appropriate location and updated naming style for some of them. Fixes: #31741 PR-URL: #31792 Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Sam Roberts <vieuxtech@gmail.com>
codebytere
pushed a commit
that referenced
this issue
Mar 23, 2020
* Updated cpp style guide file name and location and fixed links to this file. * Updated collaborator guide file name and location and fixed links to this file. * Updated documentation style guide file name and location and updated links referencing the file. * Moved files to appropriate location and updated naming style for some of them. Fixes: #31741 PR-URL: #31792 Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Sam Roberts <vieuxtech@gmail.com>
codebytere
pushed a commit
that referenced
this issue
Mar 30, 2020
* Updated cpp style guide file name and location and fixed links to this file. * Updated collaborator guide file name and location and fixed links to this file. * Updated documentation style guide file name and location and updated links referencing the file. * Moved files to appropriate location and updated naming style for some of them. Fixes: #31741 PR-URL: #31792 Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Sam Roberts <vieuxtech@gmail.com>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Over time, the docs have spread across many directory levels. I suggest they be moved around a bit to simplify the arrangement for consistency and discoverability.
Current state, edited to remove docs that are clearly in the right place (doc/changelogs, doc/api), with notes:
Also: we have randomly use both
README.md
andreadme.md
as file names, and should probably just use the uppercase version:The text was updated successfully, but these errors were encountered: