docs: add markdown alert callouts to genuine gotchas - #23
Merged
Conversation
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
added
documentation
github-project-automation
Bot
moved this to Todo
in astoncv - AstonCV full stack CV database website
zaccesss
commented
Aug 5, 2026
zaccesss
left a comment
zaccesss
left a comment
Owner
Author
There was a problem hiding this comment.
Checked before merging:
- Callouts render correctly in preview: IMPORTANT in README.md and NOTICE.md, WARNING in SECURITY.md.
- Only used where a genuine prerequisite, warning or licensing gotcha already existed, nothing decorative added.
- No wording lost, the surrounding prose still reads correctly with the callout in place.
- CI (PHP syntax check, CodeQL, Analyze) all pass on this docs-only change.
- PR shows mergeable=MERGEABLE, no conflicts.
Merging with squash.
github-project-automation
Bot
moved this from Todo
to Done
in astoncv - AstonCV full stack CV database website
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Adds GitHub markdown alert callouts to three genuine gotchas found while auditing the docs after #19 and #21. Used sparingly, only where a callout replaces something that was already a real prerequisite, warning or licensing caveat, not decoratively.
Closes #22