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

docs: add template-injection tips #259

Merged
merged 1 commit into from
Dec 9, 2024
Merged

docs: add template-injection tips #259

merged 1 commit into from
Dec 9, 2024

Conversation

woodruffw
Copy link
Owner

Signed-off-by: William Woodruff <[email protected]>
@woodruffw woodruffw added the documentation Improvements or additions to documentation label Dec 9, 2024
@woodruffw woodruffw self-assigned this Dec 9, 2024
@sethmlarson
Copy link
Collaborator

sethmlarson commented Dec 9, 2024

What are your thoughts on adding a linkable heading that you can put directly into Zizmor's errors, so users are able to see these tips right after the scanner runs and know what to do to remediate?

@woodruffw
Copy link
Owner Author

What are your thoughts on adding a linkable heading that you can put directly into Zizmor's error's, so users are able to see these tips right after the scanner runs and know what to do to remediate?

It's already there! The finding IDs should be clickable in your terminal, and will take you directly to each audit's docs.

(I'm open to ideas for how to better surface this -- OSC 8 links are great for hyperlinking but they don't make it obvious when a thing is a link 😅)

@hugovk
Copy link
Contributor

hugovk commented Dec 9, 2024

It's already there! The finding IDs should be clickable in your terminal, and will take you directly to each audit's docs.

I found this by mistake, it was a nice surprise and subsequently useful :) 🚀

Copy link
Contributor

@hugovk hugovk left a comment

Choose a reason for hiding this comment

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

Thank you!

@woodruffw woodruffw merged commit 2556f08 into main Dec 9, 2024
20 checks passed
@woodruffw woodruffw deleted the ww/clarify-docs branch December 9, 2024 16:46
@AlexWaygood
Copy link

Thanks! :D

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants