fix: correct documentation bugs and add consistency tests - #16
Open
study8677 wants to merge 1 commit into
Open
Conversation
- SKILL.md: add missing prompts.summarize_blogs reference in Step 4 - SKILL.md: include stats.blogPosts in the no-content check (Step 3) - README.md/README.zh-CN.md: fix podcast count 5 → 6, add missing "AI & I by Every" - examples/sample-digest.md: remove @Handles (violates digest-intro.md rules), fix section order to X → Blogs → Podcasts, add OFFICIAL BLOGS section - Add test-docs-consistency.js to guard against future drift Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
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.
Summary
prompts.summarize_blogsreference in Step 4 — without this, the LLM has no instruction for remixing blog postsstats.blogPostsin the no-content check (Step 3) — previously, digests with only blog content would be skipped@handles(violates digest-intro.md "NEVER write Twitter handles with @" rule), fix section order to match digest-intro.md (X → Blogs → Podcasts), add OFFICIAL BLOGS sectiontest-docs-consistency.js: 11 automated checks that guard against these docs drifting out of sync againTest plan
node scripts/test-docs-consistency.js— all 11 tests passconfig/default-sources.jsonprompts/digest-intro.mdrulesprepare-digest.js🤖 Generated with Claude Code