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.

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

Fix markdown mistakes on user guide #5672

Conversation

jkwak-work
Copy link
Collaborator

Closes #5439

@jkwak-work jkwak-work added the pr: non-breaking PRs without breaking changes label Nov 25, 2024
@jkwak-work jkwak-work self-assigned this Nov 25, 2024
@jkwak-work jkwak-work requested a review from a team as a code owner November 25, 2024 19:04
@CLAassistant
Copy link

CLAassistant commented Nov 25, 2024

CLA assistant check
All committers have signed the CLA.

Copy link
Collaborator

@aleino-nv aleino-nv left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

NOTE: I just looked at the markdown changes.

I trust you've verified that they have the desired effect on the generated documentation. (I don't know how to generate it locally, myself. How do you do that?)

@jkwak-work
Copy link
Collaborator Author

The trick is to preview the change on my own repo.
Because the change is submitted to a branch in my personal repo, you can preview the markdown change there.

@jkwak-work
Copy link
Collaborator Author

You can preview the change here

@expipiplus1 expipiplus1 merged commit 55bea7d into shader-slang:master Nov 29, 2024
2 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
pr: non-breaking PRs without breaking changes
Projects
None yet
Development

Successfully merging this pull request may close these issues.

[Doc] Fix the broken markdown syntax in the user guide
4 participants