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

[Doc] Fix the broken markdown syntax in the user guide #5439

Open
jkwak-work opened this issue Oct 29, 2024 · 1 comment · May be fixed by #5672
Open

[Doc] Fix the broken markdown syntax in the user guide #5439

jkwak-work opened this issue Oct 29, 2024 · 1 comment · May be fixed by #5672
Assignees
@jkwak-work
Labels
goal:forward looking Feature needed at a later date, not connected to a specific use case. kind:documentation areas where we can improve documentation in codebase siggraphasia-2024

Comments

@jkwak-work
Copy link
Collaborator

The second section of the user guide shows the code snippet in a strange way, which appears to be not intended.
https://shader-slang.com/slang/user-guide/conventional-features.html

image

Also some of item-list doesn't look right.
image

image
@jkwak-work jkwak-work added kind:documentation areas where we can improve documentation in codebase goal:forward looking Feature needed at a later date, not connected to a specific use case. labels Oct 29, 2024
@jkwak-work jkwak-work self-assigned this Oct 29, 2024
@csyonghe
Copy link
Collaborator

csyonghe commented Nov 4, 2024

This section should be deleted and replaced with text that is consistent with SP004 after its implementation lands.

@jkwak-work jkwak-work linked a pull request Nov 25, 2024 that will close this issue
Open
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@jkwak-work jkwak-work

Labels
goal:forward looking Feature needed at a later date, not connected to a specific use case. kind:documentation areas where we can improve documentation in codebase siggraphasia-2024
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

Fix markdown mistakes on user guide jkwak-work/slang
3 participants
@csyonghe @jkwak-work @bmillsNV