Skip to content

CONV-327: Add developer quickstart section#288

Merged
menvil merged 1 commit into
developfrom
feature/CONV-327-add-developer-quickstart-section
Jun 3, 2026
Merged

CONV-327: Add developer quickstart section#288
menvil merged 1 commit into
developfrom
feature/CONV-327-add-developer-quickstart-section

Conversation

@menvil

@menvil menvil commented Jun 3, 2026

Copy link
Copy Markdown
Owner

Summary

  • Adds 7-step developer quickstart to /docs/api page
  • Documents the full happy-path flow: authenticate → upload → estimate → convert → poll → download
  • Includes auth note about plan requirement

Test plan

  • Test written first — fails before quickstart content added
  • composer test passes (616 tests)

🤖 Generated with Claude Code


Summary by cubic

Implements CONV-327 by adding a 7-step developer quickstart to /docs/api that guides users from authentication to downloading a converted file.

  • New Features
    • Documents the happy-path flow and key endpoints, including polling.
    • Adds an auth note with the required header and Pro/Max plan requirement.

Written for commit 84c88a1. Summary will update on new commits.

Review in cubic

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
@menvil menvil merged commit cabc595 into develop Jun 3, 2026
@menvil menvil deleted the feature/CONV-327-add-developer-quickstart-section branch June 3, 2026 17:58
@coderabbitai

coderabbitai Bot commented Jun 3, 2026

Copy link
Copy Markdown

Important

Review skipped

Auto reviews are limited based on label configuration.

🏷️ Required labels (at least one) (1)
  • release

Please check the settings in the CodeRabbit UI or the .coderabbit.yaml file in this repository. To trigger a single review, invoke the @coderabbitai review command.

⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Pro

Run ID: 814d80fc-cd7e-4158-8ce3-f53aed22a5f8

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

Use the checkbox below for a quick retry:

  • 🔍 Trigger review
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch feature/CONV-327-add-developer-quickstart-section

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands and usage tips.

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