Skip to content

Commit a9d3c5e

Browse files
committed
Add todos
1 parent ba79200 commit a9d3c5e

File tree

6 files changed

+29
-1
lines changed

6 files changed

+29
-1
lines changed

docs/coming-from-glsl.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
# Migrating to Slang from GLSL
2+
3+
[//]: # (TODO: write documentation on GLSL onramp here, and update link in docs/index.md)

docs/coming-from-hlsl.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
# Migrating to Slang from HLSL
2+
3+
[//]: # (TODO: write documentation on HLSL onramp here, and update link in docs/index.md)

docs/compilation-api.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
# Using the Slang Compilation API
2+
3+
[//]: # (TODO: write documentation on compilation API here, and update link in docs/index.md)

docs/index.md

Lines changed: 14 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -27,11 +27,12 @@ Things to know when using Slang to compile to SPIR-V.
2727
#### Metal Specific Functionalities
2828

2929
Things to know when using Slang to compile to the Metal Shading Language.
30+
[//]: # (TODO: write documentation in user-guide next to spirv doc, and update link here)
3031

3132
#### WGSL Specific Functionalities
3233

3334
Things to know when using Slang to compile to the WGSL.
34-
35+
[//]: # (TODO: write documentation in user-guide next to spirv doc, and update link here)
3536

3637
## Tutorials
3738

@@ -44,15 +45,27 @@ See how to use Slang's compilation API to integrate the Slang compiler into your
4445
#### [Using the reflection API](/slang/user-guide/reflection)
4546
See how to use Slang's reflection API to query for parameter binding info at runtime.
4647

48+
#### Understanding Slang Generics
49+
50+
Learn how to use Slang's generics and interfaces to write structured code that can be
51+
specialized at compile time. This tutorial covers the differences between generics and C++ templates
52+
and how to map common templated code to generics.
53+
54+
[//]: # (TODO: write documentation and update link here)
55+
4756
#### Migrating to Slang from HLSL
4857

4958
Main things to know if you are coming to Slang as an HLSL developer.
59+
[//]: # (TODO: write documentation and update link here)
5060

5161
#### Migrating to Slang from GLSL
5262

5363
Main things to know if you are coming to Slang as an GLSL developer.
64+
[//]: # (TODO: write documentation and update link here)
5465

5566

5667
## Contributors
5768

69+
[//]: # (TODO: link more internal documentation and contribution process)
70+
5871
For contributors to the Slang project, the information under the [docs/proposals/](https://github.com/shader-slang/slang/tree/master/docs/proposals) directory documents all feature proposals to the Slang language or the compiler API.

docs/reflection-api.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
# Using the Slang Reflection API
2+
3+
[//]: # (TODO: write documentation on reflection API here, and update link in docs/index.md)

docs/understanding-generics.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
# Understanding Slang Generics
2+
3+
[//]: # (TODO: write tutorial on generics, and update link in docs/index.md)

0 commit comments

Comments
 (0)