slang icon indicating copy to clipboard operation
slang copied to clipboard

[Tutorial] Write tutorial pages for compilation API

Open jkwak-work opened this issue 1 year ago • 7 comments

We need tutorial pages for people who want to learn about the compilation API. The tutorial should also reflect some of high level principles of Slang language design that Tess presented at a recent brown-bag.

Specifically we need to fill in the TODO sections in a commit.

There are multiple "TODO" lines in the commit. This issue is for the following sections:

docs/compilation-api.md

jkwak-work avatar Oct 22 '24 21:10 jkwak-work

Reassigning to self

cheneym2 avatar Oct 29 '24 20:10 cheneym2

@csyonghe Is there any particular quality you're looking for in the tutorial? https://shader-slang.com/slang/user-guide/compiling.html#using-the-compilation-api nearly reads like a tutorial already and as I'm writing my content, I'm finding it hard to distinguish it from the user-guide.

I was thinking that it should be focused on getting one short example working, step-by-step, explaining the parts, as opposed to trying to explain everything you can do.

cheneym2 avatar Nov 13 '24 19:11 cheneym2

Does it need to be of a sufficient complexity to require linking, specialization, preprocessor macros, or should it be as small as possible?

cheneym2 avatar Nov 13 '24 19:11 cheneym2

WIP https://github.com/cheneym2/shader-slang.github.io/blob/cheneym2/compile_tutorial/docs/compilation-api.md

cheneym2 avatar Nov 13 '24 20:11 cheneym2

Please create a PR for this so we can put in review comments.

This document should aim to be as comprehensive as possible.

csyonghe avatar Nov 18 '24 19:11 csyonghe

Given that the goal is to be comprehensive rather than an introduction, it definitely needs work.

cheneym2 avatar Nov 20 '24 17:11 cheneym2

Trying to add directions for specialization, but in writing a very simple app to compile, it fails.

Filed https://github.com/shader-slang/slang/issues/5653

cheneym2 avatar Nov 24 '24 04:11 cheneym2

Closed by https://github.com/shader-slang/shader-slang.github.io/pull/25

cheneym2 avatar Dec 04 '24 00:12 cheneym2