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

doc, tools: improve the title of pages in doc #7939

Closed
wants to merge 2 commits into from
Closed

doc, tools: improve the title of pages in doc #7939

wants to merge 2 commits into from

Conversation

yorkie
Copy link
Contributor

@yorkie yorkie commented Aug 1, 2016

Checklist
  • commit message follows commit guidelines
Affected core subsystem(s)

doc, tools

Description of change

This pull-request improves the page title under generated API documentation.

R= @Trott

@yorkie yorkie added the tools Issues and PRs related to the tools directory. label Aug 1, 2016
@jasnell
Copy link
Member

jasnell commented Aug 1, 2016

LGTM

@jasnell jasnell added the doc Issues and PRs related to the documentations. label Aug 1, 2016
@addaleax
Copy link
Member

addaleax commented Aug 1, 2016

LGTM

@Trott
Copy link
Member

Trott commented Aug 1, 2016 •
edited
Loading

I don't know exactly how a lot of the docs stuff actually works, but these changes are simple enough that I feel comfortable saying:

Rubber-stamp LGTM

CI (for linting, if nothing else!): https://ci.nodejs.org/job/node-test-pull-request/3492/

@yorkie
Copy link
Contributor Author

yorkie commented Aug 2, 2016 •
edited
Loading

Sorry @Trott I did ping you is because I saw you at the top contributors in "tools/doc/html.js" and thanks for your review :-)

silverwind
silverwind reviewed Aug 2, 2016
View reviewed changes
doc/template.html
@@ -2,7 +2,7 @@
<html lang="en">
<head>
<meta charset="utf-8">
<title>__SECTION__ Node.js __VERSION__ Manual &amp; Documentation</title>
<title>__SECTION__ | Node.js __VERSION__ Manual &amp; Documentation</title>
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Maybe drop the Manual &amp; while we're here? Long titles like this usually get truncated on tabs.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

+1

On Monday, August 1, 2016, silverwind notifications@github.com wrote:

In doc/template.html
#7939 (comment):

@@ -2,7 +2,7 @@

- <title>**SECTION** Node.js **VERSION** Manual & Documentation</title> - <title>**SECTION** | Node.js **VERSION** Manual & Documentation</title>

Maybe drop the Manual & while we're here? Long titles like this
usually get truncated on tabs.

—
You are receiving this because you commented.
Reply to this email directly, view it on GitHub
https://github.com/nodejs/node/pull/7939/files/f79b4872d33cb854f5fd5661f2762c0782b98415#r73095875,
or mute the thread
https://github.com/notifications/unsubscribe-auth/AAa2eV0M2XcFXDfNPfuDQiYrWkEvxB5Wks5qbtTHgaJpZM4JZ0aC
.

@yorkie
Copy link
Contributor Author

yorkie commented Aug 2, 2016

Fixed the nit @silverwind @jasnell :-)

@jasnell
Copy link
Member

jasnell commented Aug 3, 2016

Lgtm!

@yorkie
Copy link
Contributor Author

yorkie commented Aug 3, 2016

Ping @silverwind now what's your viewpoint on #7939 (comment)? is this good to you?

@silverwind
Copy link
Contributor

Hmm, I guess Index is fine and more descriptive. LGTM.

@yorkie
Copy link
Contributor Author

yorkie commented Aug 3, 2016

Thanks and running the New CI: https://ci.nodejs.org/job/node-test-pull-request/3512.

jasnell pushed a commit that referenced this pull request Aug 4, 2016
@yorkie @jasnell
doctool: improve the title of pages in doc
a52b1c0 
PR-URL: #7939
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Anna Henningsen <anna@addaleax.net>
Reviewed-By: Rich Trott <rtrott@gmail.com>
Reviewed-By: Roman Reiss <me@silverwind.io>
@jasnell
Copy link
Member

jasnell commented Aug 4, 2016

Landed in a52b1c0! Thank you! :-)

@jasnell jasnell closed this Aug 4, 2016
@yorkie yorkie deleted the improve/doc-title branch August 5, 2016 14:55
@cjihrig cjihrig mentioned this pull request Aug 8, 2016
Closed
cjihrig pushed a commit that referenced this pull request Aug 10, 2016
@yorkie @cjihrig
doctool: improve the title of pages in doc
27f92ef 
PR-URL: #7939
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Anna Henningsen <anna@addaleax.net>
Reviewed-By: Rich Trott <rtrott@gmail.com>
Reviewed-By: Roman Reiss <me@silverwind.io>
@cjihrig cjihrig mentioned this pull request Aug 11, 2016
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers
No reviews
Assignees
No one assigned
Labels
doc Issues and PRs related to the documentations. tools Issues and PRs related to the tools directory.
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
6 participants
@yorkie @jasnell @addaleax @Trott @silverwind @MylesBorins