KhronosGroup / KhronosGroup/KSCAF_DocGuidelines
Formatting issues
@irudkin is already working on this.
Since Feb 20, 2017.
- Dominant language
- CSS
- Stars
- 2
- Forks
- 2
- PR merge metrics
- No merged PRs in 30d
Description
Here are some comments Kathleen Mattson made about the document.:
From: Kathleen Mattson [mailto:kathleen@khronos.org]
Sent: Tuesday, February 14, 2017 1:02 PM
To: Daniel Herring daniel.herring@ch1group.com
Subject: Re: SCAP question
Hi Daniel.
• I’m a little confused by the first two pages of the doc: one is a title page, but the next one has more title info. Perhaps those can be combined into a single title page? The Vulkan spec here is a very good role model: https://www.khronos.org/registry/vulkan/specs/1.0/pdf/vkspec.pdf
• I realize your doc is short enough to not need one, but if you get into a longer doc, do please add a table of contents, which should be immediately after the title page or after the trademark page.
• The Khronos logo in your doc is an ancient one :-) Please get the new logo here: https://www.khronos.org/legal/trademarks/
• The trademark statement you use is not the latest. I need to touch base with Neil to see where he has the latest… I wanted to have a regular spot for that but then it was never updated. :-( So I’ll get back to you on this one.
• In section 1, instead of "Chairman" can you instead say "Working group chair"?
• I like your icons to denote inset text — cool! :-)
• Please number and title your tables just as you did with the figures. I see that in section 5 you have a table number and title, but as it is formatted in same way used for the subsections, it took me several trips through your doc to realize that. I would format the table number/title using the same caption-looking style that you used for the figures, and I would precede the number with the word "Table"
• When you get to the appendices, then you should stop using the numeric numbering and just use the Roman letters. So in this case after section 5 you would have Appendix A… not "6. Appendix A" Again, take a look at how this was done in the Vulkan spec.
I hope this helps! Document layout is by far my favorite thing to do, so I’m happy to offer opinions any time you care to hear them. :-)
Contributor guide
No contributing guide indexed for this repository
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Assessment
This issue has not been assessed yet.