Skip to content

docs: add template-injection tips - #259

Merged
woodruffw merged 1 commit into
mainfrom
ww/clarify-docs
Dec 9, 2024
Merged

docs: add template-injection tips#259
woodruffw merged 1 commit into
mainfrom
ww/clarify-docs

Conversation

@woodruffw

Copy link
Copy Markdown
Member

Signed-off-by: William Woodruff <william@yossarian.net>
@woodruffw woodruffw added the documentation Improvements or additions to documentation label Dec 9, 2024
@woodruffw woodruffw self-assigned this Dec 9, 2024
@sethmlarson

sethmlarson commented Dec 9, 2024

Copy link
Copy Markdown

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
Copy Markdown
Member 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

hugovk commented Dec 9, 2024

Copy link
Copy Markdown
Contributor

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 :) 🚀

@hugovk hugovk left a comment

Copy link
Copy Markdown
Contributor

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
@woodruffw
woodruffw deleted the ww/clarify-docs branch December 9, 2024 16:46
@AlexWaygood

Copy link
Copy Markdown

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