Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Make slangc commandline documentation more accessible. #4124

Closed
csyonghe opened this issue May 7, 2024 · 2 comments · Fixed by #5425
Closed

Make slangc commandline documentation more accessible. #4124

csyonghe opened this issue May 7, 2024 · 2 comments · Fixed by #5425
Assignees
@cheneym2
Labels
goal:quality & productivity Quality issues and issues that impact our productivity coding day to day inside slang kind:documentation areas where we can improve documentation in codebase
Milestone
Q4 2024 (Fall)

Comments

@csyonghe
Copy link
Collaborator

csyonghe commented May 7, 2024 •
edited
Loading

  • Include a link to the documentation from main README.
  • Point to the documentation from the intro page of the user guide.
  • Add more examples on how to use the commandline tool.
@bmillsNV bmillsNV added kind:documentation areas where we can improve documentation in codebase goal:quality & productivity Quality issues and issues that impact our productivity coding day to day inside slang labels May 9, 2024
@bmillsNV bmillsNV added this to the Q2 2024 (Spring) milestone May 9, 2024
cheneym2 added a commit to cheneym2/slang that referenced this issue May 22, 2024
@cheneym2
Show slangc options in docs
0fef6aa 
Add slangc_help.txt output, generated using:

slangc -h 2> docs/slangc_help.txt

Fixes shader-slang#4124
cheneym2 added a commit to cheneym2/slang that referenced this issue May 23, 2024
@cheneym2
Show slangc options in docs
2f77b9e 
Update slangc command-line reference and link to it in
readme and user-guide.

Fixes shader-slang#4124
cheneym2 added a commit to cheneym2/slang that referenced this issue May 23, 2024
@cheneym2
Increase slangc option visibility in docs
7fdaa8f 
Update slangc command-line reference and link to it in
readme and user-guide.

Regenerates the command line reference markdown as ASCII to
make updates to it diffable in git.

Fixes shader-slang#4124
cheneym2 added a commit to cheneym2/slang that referenced this issue May 23, 2024
@cheneym2
Increase slangc option visibility in docs
d3c04ca 
Update slangc command-line reference and link to it in
readme and user-guide.

Regenerates the command line reference markdown as ASCII to
make updates to it diffable in git.

Fixes shader-slang#4124
cheneym2 added a commit to cheneym2/slang that referenced this issue May 23, 2024
@cheneym2
Increase slangc option visibility in docs
bf0cac7 
Update slangc command-line reference and link to it in
readme. Boost the visiblity of the link in the user-guide.

Regenerates the command line reference markdown as ASCII to
make updates to it diffable in git.

Fixes shader-slang#4124
@cheneym2
Copy link
Collaborator

  • Point to the documentation from the intro page of the user guide.

In order to include the slangc command-line options to the user guide introduction, the slangc application itself needs to be mentioned.

My WIP change doesn't yet add a link to slangc command-line from the user-guide intro page.

cheneym2 added a commit to cheneym2/slang that referenced this issue Jun 12, 2024
@cheneym2
Increase slangc option visibility in docs
117c139 
Update slangc command-line reference and link to it in
readme. Boost the visiblity of the link in the user-guide.

Regenerates the command line reference markdown as ASCII to
make updates to it diffable in git.

Fixes shader-slang#4124
@cheneym2
Copy link
Collaborator

The relationship between these pages is muddy:

https://shader-slang.com/slang/user-guide/compiling.html#command-line-compilation-with-slangc
https://github.com/shader-slang/slang/blob/master/docs/command-line-slangc.md
https://github.com/shader-slang/slang/blob/master/docs/command-line-slangc-reference.md

cheneym2 added a commit to cheneym2/slang that referenced this issue Oct 28, 2024
@cheneym2
Increase slangc option visibility in docs
7a78614 
Link to slangc command-line reference from readme.
readme. Boost the visiblity of the link in the user-guide.

Consolidates command-line-slangc.md into the user-guide.

Fixes shader-slang#4124
cheneym2 added a commit to cheneym2/slang that referenced this issue Oct 28, 2024
@cheneym2
Increase slangc option visibility in docs
790d116 
Link to slangc command-line reference from readme.
readme. Boost the visiblity of the link in the user-guide.

Consolidates command-line-slangc.md into the user-guide.

Fixes shader-slang#4124
@cheneym2 cheneym2 mentioned this issue Oct 28, 2024
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@cheneym2 cheneym2

Labels
goal:quality & productivity Quality issues and issues that impact our productivity coding day to day inside slang kind:documentation areas where we can improve documentation in codebase
Projects
None yet
Milestone
Q4 2024 (Fall)
Development

Successfully merging a pull request may close this issue.

Increase slangc option visibility in docs cheneym2/slang
3 participants
@csyonghe @cheneym2 @bmillsNV