Skip to content

Added Claude based docs validator. #2967

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.

Sign up for GitHub

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

Merged
seanparsons merged 1 commit into from
Jun 3, 2025
Merged

Added Claude based docs validator. #2967

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
13 changes: 13 additions & 0 deletions packages/hydrogen/check-docs.sh
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
#!/usr/bin/env bash
set -e

# Get the absolute path to the src directory.
SRC_DIR="$(git rev-parse --show-toplevel)/packages/hydrogen/src/"

# Get claude to check the docs.
claude --print "In the directory $SRC_DIR, there are .doc.ts files which match up with similarly named files that end with .ts or .tsx.\
Those .doc.ts files describe a series of examples with a description and have file paths which point to example files.\
Check that the original code referred to matches up with the examples and their description.\
Please output a list of the files, pairing their filenames with the issues found.\
Don't output anything about successes or files without any problems.\
If no issues have been found, please output 'No issues found'."
Loading