Skip to content

Fix descriptions workflow: flag missing front matter in docs/, unarchive action - #695

Open
fscelliott wants to merge 2 commits into
v0from
fix/descriptions-workflow
Open

Fix descriptions workflow: flag missing front matter in docs/, unarchive action#695
fscelliott wants to merge 2 commits into
v0from
fix/descriptions-workflow

Conversation

@fscelliott

Copy link
Copy Markdown
Collaborator

Summary

  • SDK quickstart front matter: Added excerpt, metadata.title, metadata.description, and next to node-sdk-quickstart.md and python-sdk-quickstart.md, which were missing these fields entirely.
  • check_descriptions.py: Now flags docs/ files that are missing the metadata.description key entirely (not just files where the key exists but is empty). reference/ files continue to silently skip when the key is absent.
  • add_description.py: Now inserts metadata.description when the key doesn't exist yet, instead of returning early. Previously the workflow could generate a description but silently fail to write it.
  • generate-descriptions.yml: Unarchived from .github/workflows/archive/.github/workflows/. Added a sync_excerpt.py step so excerpt is populated in the same automated PR. Bumped model ID to claude-sonnet-4-6.

Test plan

  • Verify check_descriptions.py flags a docs/ file with no metadata.description key
  • Verify check_descriptions.py does NOT flag a reference/ file with no metadata.description key
  • Verify add_description.py writes the description correctly when the key is absent
  • Verify the workflow triggers on push to v0 with a changed .md file and creates a PR

🤖 Generated with Claude Code

fscelliott and others added 2 commits August 25, 2026 15:07
- Add excerpt/description/title front matter to node and python SDK quickstart pages
- check_descriptions.py: flag docs/ files missing metadata.description key entirely (reference/ still silently skips)
- add_description.py: insert metadata.description when key is absent, not only when it exists but is empty
- Unarchive generate-descriptions.yml and add sync_excerpt.py step so excerpt is populated in the same PR
- Bump model ID to claude-sonnet-4-6

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant