m1ngsama/chopsticks
1
0
Fork 0
mirror of https://oauth2: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@github.com/m1ngsama/chopsticks.git synced 2026-06-26 05:44:38 +08:00
Code Issues Projects Releases Packages Wiki Activity Actions

Add beta documentation consistency check

Browse source
This commit is contained in:
m1ngsama 2026-05-23 19:38:48 +08:00
parent 87719ebdd3
commit a4ea56525f
2 changed files with 15 additions and 2 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

5
README.md
View file

@ -145,8 +145,9 @@ for native `S`.
For onboarding, use `:ChopsticksTutor` for a guided practice page, `SPC ?` for For onboarding, use `:ChopsticksTutor` for a guided practice page, `SPC ?` for
the active keymap, and `:ChopsticksStatus` for tool/LSP health. the active keymap, and `:ChopsticksStatus` for tool/LSP health.
`QUICKSTART.md` is the 5-minute path; this README is the full reference. `QUICKSTART.md` is the 5-minute path; this README is the full reference.
During the beta, `:ChopsticksBeta` opens the in-editor test checklist and During the beta, `:ChopsticksBeta` opens the in-editor test checklist,
`:ChopsticksBetaLog` opens editable local notes. `:ChopsticksBetaLog` opens editable local notes, and `:ChopsticksBetaSession`
appends a timestamped session block.
``` ```
SPC SPC fuzzy find file gd go to definition SPC SPC fuzzy find file gd go to definition

12
scripts/test-quick.sh
View file

@ -28,6 +28,18 @@ check_docs() {
need markdownlint need markdownlint
markdownlint README.md QUICKSTART.md CONTRIBUTING.md CHANGELOG.md BETA.md markdownlint README.md QUICKSTART.md CONTRIBUTING.md CHANGELOG.md BETA.md
step "Documentation consistency"
for command in ChopsticksBeta ChopsticksBetaLog ChopsticksBetaSession; do
for file in README.md BETA.md modules/beta.vim modules/cheatsheet.vim \
modules/tutor.vim modules/status.vim
do
grep -Fq "$command" "$file" || {
echo "Missing $command in $file" >&2
exit 1
}
done
done
if command -v vhs >/dev/null 2>&1; then if command -v vhs >/dev/null 2>&1; then
vhs validate .github/demo.tape vhs validate .github/demo.tape
else else