Skip to content

Fix generate.json documentation to use URL parameter#6

Merged
MrTravisB merged 1 commit intomainfrom
travis/fix-generate
Nov 14, 2025
Merged

Fix generate.json documentation to use URL parameter#6
MrTravisB merged 1 commit intomainfrom
travis/fix-generate

Conversation

@MrTravisB
Copy link
Copy Markdown
Collaborator

Summary

  • Fixed README documentation for generate.json() to correctly show it takes a url parameter, not markdown
  • Updated Quick Start section to remove incorrect two-step process
  • Updated API Reference section with correct method signature and parameters

Details

The implementation was already correct - generate.json() accepts a URL as per the OpenAPI spec. Only the README had outdated documentation suggesting a two-step process (extract markdown, then generate from markdown).

Changes

  • Quick Start: Changed from two-step markdown extraction to direct URL usage
  • API Reference: Updated method signature from generate.json(markdown, instructions, schema) to generate.json(url, schema, instructions, nocache=False)
  • Updated all example code in documentation

Testing

✅ All 165 tests pass
✅ No code changes needed - implementation was correct

🤖 Generated with Claude Code

Generated with [Claude Code](https://claude.com/claude-code)

Co-Authored-By: Claude <noreply@anthropic.com>
@MrTravisB MrTravisB merged commit 1eddc93 into main Nov 14, 2025
6 checks passed
@MrTravisB MrTravisB deleted the travis/fix-generate branch November 14, 2025 02:58
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