Skip to content

docs: add markdown alert callouts to genuine gotchas - #25

Merged
zaccesss merged 1 commit into
mainfrom
docs/add-callouts
Aug 5, 2026
Merged

docs: add markdown alert callouts to genuine gotchas#25
zaccesss merged 1 commit into
mainfrom
docs/add-callouts

Conversation

@zaccesss

@zaccesss zaccesss commented Aug 5, 2026

Copy link
Copy Markdown
Owner

Closes #24

Adds GitHub markdown alert callouts to README, NOTICE and SECURITY where they flag something a reader could genuinely miss.

Adds an IMPORTANT callout to the README's Local setup for the
missing schema file, a WARNING callout to SECURITY.md for
reporting vulnerabilities privately and an IMPORTANT callout to
NOTICE.md for the campus photography licensing exception.

Closes #22
@zaccesss zaccesss added documentation Improvements or additions to documentation quick-win Small and high value, do in a spare moment autoclose Close this issue when a PR that references it merges labels Aug 5, 2026

@zaccesss zaccesss left a comment

Copy link
Copy Markdown
Owner Author

Choose a reason for hiding this comment

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

Checked, callouts read cleanly and flag genuine gotchas without spamming. Good to merge.

@zaccesss
zaccesss merged commit c86e75a into main Aug 5, 2026
5 checks passed
@zaccesss
zaccesss deleted the docs/add-callouts branch August 5, 2026 19:00
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

autoclose Close this issue when a PR that references it merges documentation Improvements or additions to documentation quick-win Small and high value, do in a spare moment

Development

Successfully merging this pull request may close these issues.

README, NOTICE and SECURITY could use markdown alert callouts

1 participant