Skip to content

Commit dacfa15

Browse files
[Docs] Re-run build_toc and fix dead links (shader-slang#5647)
* re-run build_toc.ps1 * fix dead link of readme --------- Co-authored-by: Ellie Hermaszewska <ellieh@nvidia.com>
1 parent 65a761a commit dacfa15

File tree

2 files changed

+31
-28
lines changed

2 files changed

+31
-28
lines changed

README.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -85,7 +85,7 @@ The following guidelines should be observed by contributors:
8585
* Changes should ideally come in as small pull requests on top of `master`, coming from your own personal fork of the project
8686
* Large features that will involve multiple contributors or a long development time should be discussed in issues, and broken down into smaller pieces that can be implemented and checked in in stages
8787

88-
[Contribution guide](CONTRIBUTION.md) describes the workflow for contributors at more detail.
88+
[Contribution guide](CONTRIBUTING.md) describes the workflow for contributors at more detail.
8989

9090
Limitations and Support
9191
-----------------------

docs/user-guide/toc.html

+30-27
Original file line numberDiff line numberDiff line change
@@ -125,6 +125,19 @@
125125
<li data-link="reflection#function-reflection"><span>Function Reflection</span></li>
126126
</ul>
127127
</li>
128+
<li data-link="targets"><span>Supported Compilation Targets</span>
129+
<ul class="toc_list">
130+
<li data-link="targets#background-and-terminology"><span>Background and Terminology</span></li>
131+
<li data-link="targets#direct3d-11"><span>Direct3D 11</span></li>
132+
<li data-link="targets#direct3d-12"><span>Direct3D 12</span></li>
133+
<li data-link="targets#vulkan"><span>Vulkan</span></li>
134+
<li data-link="targets#opengl"><span>OpenGL</span></li>
135+
<li data-link="targets#metal"><span>Metal</span></li>
136+
<li data-link="targets#cuda-and-optix"><span>CUDA and OptiX</span></li>
137+
<li data-link="targets#cpu-compute"><span>CPU Compute</span></li>
138+
<li data-link="targets#summary"><span>Summary</span></li>
139+
</ul>
140+
</li>
128141
<li data-link="link-time-specialization"><span>Link-time Specialization and Module Precompilation</span>
129142
<ul class="toc_list">
130143
<li data-link="link-time-specialization#link-time-constants"><span>Link-time Constants</span></li>
@@ -182,20 +195,8 @@
182195
</li>
183196
</ul>
184197
</li>
185-
<li data-link="reference"><span>Reference</span>
186-
<ul class="toc_list">
187-
<li data-link="a3-02-reference-capability-atoms"><span>Capability Atoms</span>
198+
<li data-link="a2-target-specific-features"><span>Target-specific features</span>
188199
<ul class="toc_list">
189-
<li data-link="a3-02-reference-capability-atoms#targets"><span>Targets</span></li>
190-
<li data-link="a3-02-reference-capability-atoms#stages"><span>Stages</span></li>
191-
<li data-link="a3-02-reference-capability-atoms#versions"><span>Versions</span></li>
192-
<li data-link="a3-02-reference-capability-atoms#extensions"><span>Extensions</span></li>
193-
<li data-link="a3-02-reference-capability-atoms#compound-capabilities"><span>Compound Capabilities</span></li>
194-
<li data-link="a3-02-reference-capability-atoms#other"><span>Other</span></li>
195-
</ul>
196-
</li>
197-
</ul>
198-
</li>
199200
<li data-link="spirv-target-specific"><span>SPIR-V specific functionalities</span>
200201
<ul class="toc_list">
201202
<li data-link="spirv-target-specific#experimental-support-for-the-older-versions-of-spir-v"><span>Experimental support for the older versions of SPIR-V</span></li>
@@ -205,17 +206,17 @@
205206
<li data-link="spirv-target-specific#supported-hlsl-features-when-targeting-spir-v"><span>Supported HLSL features when targeting SPIR-V</span></li>
206207
<li data-link="spirv-target-specific#unsupported-glsl-keywords-when-targeting-spir-v"><span>Unsupported GLSL keywords when targeting SPIR-V</span></li>
207208
<li data-link="spirv-target-specific#supported-atomic-types-for-each-target"><span>Supported atomic types for each target</span></li>
208-
<li data-link="spirv-target-specific#constantbuffer-rwrasterizerorderedstructuredbuffer-rwrasterizerorderedbyteaddressbuffer"><span>ConstantBuffer, StructuredBuffer and ByteAddressBuffer</span></li>
209+
<li data-link="spirv-target-specific#constantbuffer-structuredbuffer-and-byteaddressbuffer"><span>ConstantBuffer, StructuredBuffer and ByteAddressBuffer</span></li>
209210
<li data-link="spirv-target-specific#parameterblock-for-spir-v-target"><span>ParameterBlock for SPIR-V target</span></li>
210211
<li data-link="spirv-target-specific#push-constants"><span>Push Constants</span></li>
211212
<li data-link="spirv-target-specific#specialization-constants"><span>Specialization Constants</span></li>
212-
<li data-link="spirv-target-specific#spir-v-specific-compiler-options"><span>SPIR-V specific Compiler options</span></li>
213213
<li data-link="spirv-target-specific#spir-v-specific-attributes"><span>SPIR-V specific Attributes </span></li>
214214
<li data-link="spirv-target-specific#multiple-entry-points-support"><span>Multiple entry points support</span></li>
215-
<li data-link="spirv-target-specific#memory-pointer-is-experimental"><span>Global memory pointers</span></li>
215+
<li data-link="spirv-target-specific#global-memory-pointers"><span>Global memory pointers</span></li>
216216
<li data-link="spirv-target-specific#matrix-type-translation"><span>Matrix type translation</span></li>
217217
<li data-link="spirv-target-specific#legalization"><span>Legalization</span></li>
218218
<li data-link="spirv-target-specific#tessellation"><span>Tessellation</span></li>
219+
<li data-link="spirv-target-specific#spir-v-specific-compiler-options"><span>SPIR-V specific Compiler options</span></li>
219220
</ul>
220221
</li>
221222
<li data-link="metal-target-specific"><span>Metal-specific functionalities</span>
@@ -243,28 +244,30 @@
243244
<li data-link="wgsl-target-specific#interlocked-operations"><span>Interlocked operations</span></li>
244245
<li data-link="wgsl-target-specific#entry-point-parameter-handling"><span>Entry Point Parameter Handling</span></li>
245246
<li data-link="wgsl-target-specific#parameter-blocks"><span>Parameter blocks</span></li>
247+
<li data-link="wgsl-target-specific#write-only-textures"><span>Write-only Textures</span></li>
246248
<li data-link="wgsl-target-specific#pointers"><span>Pointers</span></li>
247249
<li data-link="wgsl-target-specific#address-space-assignment"><span>Address Space Assignment</span></li>
248250
<li data-link="wgsl-target-specific#matrix-type-translation"><span>Matrix type translation</span></li>
249251
</ul>
250252
</li>
251-
<li data-link="a2-target-specific-features"><span>Target-specific features</span>
253+
</ul>
252254
</li>
255+
<li data-link="reference"><span>Reference</span>
256+
<ul class="toc_list">
253257
<li data-link="a3-01-reference-capability-profiles"><span>Capability Profiles</span>
254258
</li>
255-
<li data-link="targets"><span>Supported Compilation Targets</span>
259+
<li data-link="a3-02-reference-capability-atoms"><span>Capability Atoms</span>
256260
<ul class="toc_list">
257-
<li data-link="targets#background-and-terminology"><span>Background and Terminology</span></li>
258-
<li data-link="targets#direct3d-11"><span>Direct3D 11</span></li>
259-
<li data-link="targets#direct3d-12"><span>Direct3D 12</span></li>
260-
<li data-link="targets#vulkan"><span>Vulkan</span></li>
261-
<li data-link="targets#opengl"><span>OpenGL</span></li>
262-
<li data-link="targets#metal"><span>Metal</span></li>
263-
<li data-link="targets#cuda-and-optix"><span>CUDA and OptiX</span></li>
264-
<li data-link="targets#cpu-compute"><span>CPU Compute</span></li>
265-
<li data-link="targets#summary"><span>Summary</span></li>
261+
<li data-link="a3-02-reference-capability-atoms#targets"><span>Targets</span></li>
262+
<li data-link="a3-02-reference-capability-atoms#stages"><span>Stages</span></li>
263+
<li data-link="a3-02-reference-capability-atoms#versions"><span>Versions</span></li>
264+
<li data-link="a3-02-reference-capability-atoms#extensions"><span>Extensions</span></li>
265+
<li data-link="a3-02-reference-capability-atoms#compound-capabilities"><span>Compound Capabilities</span></li>
266+
<li data-link="a3-02-reference-capability-atoms#other"><span>Other</span></li>
266267
</ul>
267268
</li>
268269
</ul>
269270
</li>
270271
</ul>
272+
</li>
273+
</ul>

0 commit comments

Comments
 (0)