Editorial: fix link in README.md #69
Conversation
README.md
Outdated
| @@ -4,4 +4,4 @@ This is the issue tracking repository for Digital Publishing WAI-ARIA Module (dp | |||
|
|
|||
| You can also compare against [the most recent published version here](https://www.w3.org/TR/dpub-aria-1.0/). | |||
|
|
|||
| To open a PR, please see the [main ARIA repository where the specification lives](https://github.com/w3c/aria/dpub-aria). This specification is part of the [ARIA suite](https://www.w3.org/WAI/ARIA/deliverables), and uses the same code structure and build tools as other ARIA suites. General information about editing specifications is in the [main ARIA repository readme](https://github.com/w3c/aria/). | |||
| To open a PR, please see the [main ARIA repository where the specification lives](https://github.com/w3c/aria/tree/main/dpub-aria). This specification is part of the [ARIA suite](https://www.w3.org/WAI/ARIA/deliverables), and uses the same code structure and build tools as other ARIA suites. General information about editing specifications is in the [main ARIA repository readme](https://github.com/w3c/aria/). | |||
There was a problem hiding this comment.
| To open a PR, please see the [main ARIA repository where the specification lives](https://github.com/w3c/aria/tree/main/dpub-aria). This specification is part of the [ARIA suite](https://www.w3.org/WAI/ARIA/deliverables), and uses the same code structure and build tools as other ARIA suites. General information about editing specifications is in the [main ARIA repository readme](https://github.com/w3c/aria/). | |
| To open a PR, please see the [main ARIA repository where the specification lives](https://w3c.github.io/aria/). This specification is part of the [ARIA suite](https://www.w3.org/WAI/ARIA/deliverables), and uses the same code structure and build tools as other ARIA suites. General information about editing specifications is in the [main ARIA repository readme](https://github.com/w3c/aria/). |
I would think that the goal was to refer to the editors' draft of the document itself. The original reference was indeed a 404, but the proposed change in the PR led to the source in the repository. Hence my proposal for a change of the change...
There was a problem hiding this comment.
Sending people to the ARIA editor's draft to open a pull request for DPUB-ARIA doesn't seem helpful. Granted, the first link doesn't lead people anywhere helpful, either, as it just makes you follow another link back to the repository root. As best I can tell, the info on opening pull requests is here: https://github.com/w3c/aria/#non-editor-contributions
There was a problem hiding this comment.
Ah interesting feedback, my intent was to show where the source documents for for the specification resides, thus the link directly to the html document in the ARIA repository. If someone came to this repository looking for the source documents because they expected them here, I'd guess what they now need is a direct link to the new location of the source documents.
The readme, which you suggested linking to, is also linked in a following sentence "General information about editing specifications is in the main ARIA repository readme." But perhaps I should say "General information about contributing to the specification is in the main ARIA repository readme."
There was a problem hiding this comment.
my intent was to show where the source documents for for the specification resides
It might be better to lead with something other than "To open a PR" in that case. I expected it to lead to the pull request tab or the instructions. "To view the specification source", or something along those lines, would fit with the paragraphs above indicating how to get to the REC and ED docs. The rest about reviewing the main repo for further information then seems fine.
There was a problem hiding this comment.
sounds good, updated!
|
iherman marked as non substantive for IPR from ash-nazg. |
No description provided.