KhronosGroup / KhronosGroup/SYCL_Reference

"Backends" and "Class availability" chapters desing

Open
#130 3 comments 0 reactions 0 assignees View on GitHub
Dominant language
C++
Stars
31
Forks
26
PR merge metrics
No merged PRs in 30d

Description

Currently, the [Backends](https://registry.khronos.org/SYCL/specs/sycl-2020/html/sycl-2020.html#sec:backends), [Generic vs non-generic SYCL](https://registry.khronos.org/SYCL/specs/sycl-2020/html/sycl-2020.html#sec:generic-vs-non-generic), and [Class availability](https://registry.khronos.org/SYCL/specs/sycl-2020/html/sycl-2020.html#_class_availability) chapters are not represented in the Reference Guide.

We propose to add it with the following structure (on the higher level of hierarchy):

- Backends ([4.1. Backends](https://registry.khronos.org/SYCL/specs/sycl-2020/html/sycl-2020.html#sec:backends) and [4.2. Generic vs non-generic SYCL](https://registry.khronos.org/SYCL/specs/sycl-2020/html/sycl-2020.html#sec:generic-vs-non-generic))
- Class availability ([4.4. Class availability](https://registry.khronos.org/SYCL/specs/sycl-2020/html/sycl-2020.html#_class_availability))

Those chapters will appear sequentially after "Namespaces" in the contents bar.
![image](https://github.com/KhronosGroup/SYCL_Reference/assets/122783909/47eeceb1-7c8d-4825-b927-32c763fd8756)

Could you please review and provide your opinion and recommendations for those chapters?
We will create PR after a discussion.

Contributor guide

No contributing guide indexed for this repository

Research direction

Start by comparing the linked SYCL specification sections for Backends, Generic vs non-generic SYCL, and Class availability with the Reference Guide contents around Namespaces. Done means agreeing on the proposed hierarchy and adding the chapters sequentially after Namespaces in a follow-up PR.

Written by the indexing model from the issue text.

Assessment

Tech stack
cpp
Domain
documentation
Issue type
Documentation
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.