KhronosGroup / KhronosGroup/OpenCL-Docs

"Style guide" for the specs

Open
#1,082 0 comments 0 reactions 1 assignee Claimed by @bashbaug View on GitHub
enhancement
Dominant language
Python
Stars
420
Forks
131
Avg merge
5d 13h
Merged PRs (30d)
11

Description

Spinning off some side discussion on #950, it would be helpful for future contributors to document some of the repo-specific markup, especially the varying forms of {clAPIname} macros used to generate xrefs and links. Some of the Vulkan style guide is applicable, like the descriptions of open block markup from whence refpages are extracted, as well. While this can mostly be inferred by pattern-matching, documentation is better. Need not be nearly as extensive as the Vulkan guide. I could contribute to this if that would be helpful, but it's mostly a spec editor thing.

Contributor guide

Open the contributing guide

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.