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.

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

Minor documentation update #160

Merged
merged 4 commits into from
Mar 2, 2016
Merged

Minor documentation update #160

merged 4 commits into from
Mar 2, 2016

Conversation

edwardhorsford
Copy link
Contributor

Three minor corrections:

  • Fix typo in guidance
  • Add note that WARNs in npm install are ok.
  • Force new window on the link to the prototype.

@@ -20,7 +20,7 @@ Listening on port 3000 url: http://localhost:3000

## Check it works

In your web browser, visit [http://localhost:3000](http://localhost:3000)
In your web browser, visit <a href="http://localhost:3000" target="_blank">http://localhost:3000<span class="visuallyHidden"> (opens in a new window)</span></a>
Copy link
Contributor

Choose a reason for hiding this comment

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

don't think this needs a new window?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

I think it does. I observed a user yesterday follow the link from the docs, thereby loosing the documentation which has more to say - and in the future might have 'next steps'. Better to open in a new window IMHO.

Copy link
Contributor

Choose a reason for hiding this comment

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

they didnt know to click back? I've seen more issues with people getting lost with new windows - you can't click back, theres no obvious thing to do to get back

Copy link
Contributor Author

Choose a reason for hiding this comment

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

I think they're rather likely to want both open simultaneously. So they can play about with the kit whilst reading the docs.

These are also likely to be designers / people working on the kit - I am assuming that most of our users are likely to be able to handle different tabs, etc.

Copy link
Contributor

Choose a reason for hiding this comment

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

ok, but I think the warning is useful to all users, not just screen readers. And should it be "opens in a new tab"?

@edwardhorsford
Copy link
Contributor Author

@joelanman I've addressed your comments.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants