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

Breadcrumb #266

Merged
merged 5 commits into from
Feb 6, 2017
Merged

Breadcrumb #266

merged 5 commits into from
Feb 6, 2017

Conversation

ZoeBijl
Copy link
Contributor

@ZoeBijl ZoeBijl commented Jan 31, 2017

Fix issues in #187. Please squash the commits in this PR.

modified examples/breadcrumb/index.html:
* Changed crumb links to better represent the position of this page in APG architecture. The first link should point to main doc, not outside APG. The second link is for the design pattern section, the third link for the breadcrumb pattern, and the final link to the breadcrumb example page.
* Editorial revisions to intro and accessibility features.
modified examples/breadcrumb/index.html:
1. Remove links from states and properties in Breadcrumb example. We are not maintaining links to the aria spec or html spec from example pages; they are not respec documents.
2. Editorial revision to description in aria-current row.
modified examples/breadcrumb/index.html:
In the states and properties table, added a row for the nav element and aria-label property.
@mcking65
Copy link
Contributor

@MichielBijl,

I added 3 more commits.

If you and @jnurthen are OK with the changes, I see no need to keep all the individual commits in the history ... we should squash it.

@ZoeBijl
Copy link
Contributor Author

ZoeBijl commented Feb 2, 2017

I’m fine with all but the removal of the links to properties and elements. I for one find it very useful to have cross references to other specs and the like. This is also a step towards the more “developer reference”-ness of the APG. It makes it a lot easier to look up elements and attributes that you might not be familiar with.

We can discuss where it should link, but I figured TR would be the correct location.

Any arguments to take it out?

@mcking65
Copy link
Contributor

mcking65 commented Feb 3, 2017

We do not have the role/state/property links in the example pages because we do not have a way of ensuring they point to the correct place. The example pages are not respec documents. During the editors' call, I had a discussion with Michael about isolating just the reference generation capabilities of respec for certain pages so we could do things like that. We do not want to turn the example pages into respec docs.

In general, I don't think we should link to other specs unless there is something unusual that justifies it. For example, I think it is better not to have links to the spec for common html elements. They could be more of a distraction than a help to readers.

Would you be interested in taking on issue #270?

@mcking65 mcking65 merged commit d0f7ae4 into master Feb 6, 2017
@ZoeBijl ZoeBijl deleted the breadcrumb branch February 6, 2017 18:20
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.

None yet

2 participants