docs: add pre-commit hook to enforce hyphen-based markdown filenames #1278
Conversation
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
- Add check-markdown-filename hook to validate markdown file naming - Reject files containing underscores (except those starting with _) - Provide helpful error messages with renaming examples - Update standardize-doc.md workflow documentation - Add requirement for download.md placement in top-level directory - Specify download.md should have sidebar_position: 99
![windsurf-bot[bot]](https://avatars.githubusercontent.com/in/1066231?s=60&v=4){kind=small}
Comment on lines
+125
to
+127
| if [[ "$filename" =~ ^_ ]]; then | ||
| continue | ||
| fi |
Contributor
There was a problem hiding this comment.
The script skips files that start with an underscore (if [[ "$filename" =~ ^_ ]]; then continue; fi), but it's not clear why this exception exists. Consider adding a comment explaining why files starting with underscores are allowed, especially since the hook's purpose is to enforce hyphen usage instead of underscores.
xzl01
changed the title
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.
Description of changes