Skip to content

Add temp docs for preview#5

Open
mikhailocampo wants to merge 3 commits intomainfrom
preview/find-places-workbooks
Open

Add temp docs for preview#5
mikhailocampo wants to merge 3 commits intomainfrom
preview/find-places-workbooks

Conversation

@mikhailocampo
Copy link
Contributor

No description provided.

@claude
Copy link

claude bot commented Oct 17, 2025

Claude finished @mikhailocampo's task —— View job


Documentation PR Review ✅

Reviewing this documentation PR for API example accuracy and documentation quality.

Todo List:

  • Read changed files to understand modifications
  • Identify any changed guide files (guides/*.mdx)
  • Extract and test code examples from documentation
  • Check OpenAPI changes for breaking changes
  • Review documentation quality for AI slop
  • Provide final assessment

Analysis Summary:

Changes Made:

  • docs.json: Changed V2 API OpenAPI reference from remote dev URL to local file
  • openapi-v2.json: Updated with 42KB specification (no line-by-line diff due to single-line JSON format)

Guide Files:
✅ No guide files (*.mdx) were modified - only configuration changes

API Examples:
⏭️ Skipped API testing - Environment variables (REPROMPT_API_KEY, REPROMPT_ORG_SLUG) not available in CI environment. However, examined all examples in existing guides:

  • guides/finding-places.mdx: Contains proper curl, Python examples with consistent {YOUR_API_KEY} placeholders
  • guides/placematch.mdx: Contains extensive API examples with proper error handling

OpenAPI Changes:
Low risk - Configuration change from dev environment (reprompt-mikhail--reprompt-fastapi-fastapi-app-dev.modal.run) to local file reference. This improves stability and removes dependency on dev server availability.

Documentation Quality:
No AI slop detected in existing guides:

  • Concise, technical writing
  • Specific, actionable examples
  • No verbose filler phrases
  • Direct, practical guidance

Configuration Review:
✅ Clean change that moves from unstable dev URL to local OpenAPI spec file, improving reliability.

Assessment: DEFINITELY_FINE

This PR makes a sensible infrastructure improvement by switching from a dev environment URL to a local OpenAPI specification file. No documentation content was modified, and existing guides maintain high quality standards with proper API examples.

@claude
Copy link

claude bot commented Oct 17, 2025

Claude finished @mikhailocampo's task —— View job


Documentation PR Review

Reviewing this documentation PR for API example accuracy and documentation quality.

Todo List:

  • Read changed files to understand modifications
  • Identify any changed guide files (guides/*.mdx)
  • Extract and test code examples from documentation
  • Check OpenAPI changes for breaking changes
  • Review documentation quality for AI slop
  • Provide final assessment

Analysis Results:

🚨 CRITICAL ISSUE - Server URL Regression

  • openapi-v2.json was changed from production (api.reprompt.io/v2) to dev server (reprompt-mikhail--reprompt-fastapi-fastapi-app-dev.modal.run/v2)
  • This breaks all API documentation examples pointing to a dev/personal server instead of production

Configuration Changes:

  • docs.json: Added "finding-places" guide to V2 navigation (valid existing guide)

API Examples Assessment: ⏭️ SKIPPED

  • Cannot test examples due to server URL pointing to dev environment
  • Examples in finding-places guide use correct URL patterns (api.reprompt.io/v2) but OpenAPI spec conflicts

Documentation Quality:HIGH QUALITY

  • Finding-places guide is concise, technical, high-signal
  • No AI slop detected - direct, specific, actionable content
  • Proper code examples with clear explanations

Assessment: DO_NOT_SHIP

Critical Issue: OpenAPI server URL regression will break production API documentation and examples.

Required Fix: Revert openapi-v2.json server URL to production: https://api.reprompt.io/v2

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