aria-practices icon indicating copy to clipboard operation
aria-practices copied to clipboard

Guidance on usage of Authoring Practices Guide vs. editor’s drafts

Open thibaudcolas opened this issue 2 years ago • 2 comments

Separately to – #2332 I’d like to request a few changes on the APG About page based on my first-time experience:

  • The Introduction section is very long. All of it seems like valuable information but I had a hard time feeling motivated to read it all. Could it be structured into further sub-sections with their own headings, to make it easier to scan the contents?
  • In the past I’ve always sent people towards the 1.3 editor’s draft. Could there be a section on the About page (perhaps under Change History?) or elsewhere to clearly state how this document differs from 1.3? Perhaps link to the 1.3 editor’s draft with the appropriate caveats.

thibaudcolas avatar May 24 '22 10:05 thibaudcolas

The ARIA Authoring Practices (APG) Task Force just discussed Guidance on usage of Authoring Practices Guide vs. editor’s drafts.

The full IRC log of that discussion <MarkMcCarthy> TOPIC: Guidance on usage of Authoring Practices Guide vs. editor’s drafts
<jamesn> github: https://github.com/w3c/aria-practices/issues/2356
<MarkMcCarthy> Matt_King: 2 issues in this, one on the intro and one on the editor's draft
<MarkMcCarthy> Matt_King: editor's draft part of this should be straightforward, eventually.
<jongunderson> https://w3c.github.io/aria-practices
<MarkMcCarthy> Matt_King: the rendering of the main branch (the current "editor's draft") will be replaced by our site here - when we update the main branch, it'll get pushed to the site by the W3C
<MarkMcCarthy> jongunderson: how do we preview things?
<MarkMcCarthy> Matt_King: PRs will have a netlify preview now
<MarkMcCarthy> Matt_King: there's also a netlify preview for the main branch
<MarkMcCarthy> Matt_King: not useful to point people to that though, it's only good for a day or two at atime
<MarkMcCarthy> Matt_King: approximately this will all happen towards the end of june, but here's still planning to do
<MarkMcCarthy> MarkMcCarthy: what about their introduction comment?
<MarkMcCarthy> MarkMcCarthy: part of the plan is to create a TOC, separate the intro out, and make things a little more independent
<MarkMcCarthy> s/MarkMcCarthy: part/Matt_King: part

css-meeting-bot avatar May 24 '22 18:05 css-meeting-bot

Another comment about the readability/legibility of the APG About page...

Maybe set a max character limit on lines of freeform text? i.e. no more than 80 chars.

basher avatar Jun 08 '22 13:06 basher

Related pull requests:

  • The editor's draft on github.io has been sunset by #2419 and #2639.
  • The introduction is being rewritten by #2558.

mcking65 avatar Mar 07 '23 20:03 mcking65

All feedback addressed by above referenced issues.

mcking65 avatar Jul 25 '23 19:07 mcking65