Skip to content

feat: add beginner-friendly first request guide#7

Merged
lhagenWP merged 1 commit intomainfrom
add-api-key-instructions-page
Jan 30, 2026
Merged

feat: add beginner-friendly first request guide#7
lhagenWP merged 1 commit intomainfrom
add-api-key-instructions-page

Conversation

@KevinEdry
Copy link
Collaborator

@KevinEdry KevinEdry commented Jan 29, 2026

Summary

Adds a new "Making Your First Request" documentation page to help non-technical trial users successfully make their first API call.

  • Add interactive API key tester component (try it in browser)
  • Add "Run in Postman" button with pre-configured collection
  • Add step-by-step Postman and cURL instructions
  • Add troubleshooting section for common errors
  • Update getting-started page with link to new guide
  • Add Postman button to README

Test plan

  • Verify page renders at /documentation/making-your-first-request
  • Test API key tester component with valid/invalid keys
  • Verify "Run in Postman" button opens Postman with collection
  • Check navigation shows new page after "Getting a Trial API Key"
  • Verify getting-started page shows callout linking to new guide

@KevinEdry KevinEdry force-pushed the add-api-key-instructions-page branch from 5e6704a to 16153d8 Compare January 30, 2026 17:36
Add new "Making Your First Request" documentation page to help non-technical
trial users successfully make their first API call.

Changes:
- Add interactive API key tester component
- Add "Run in Postman" button linking to synced Postman collection
- Add step-by-step Postman and cURL instructions
- Add troubleshooting section for common errors
- Update getting-started page with link to new guide
- Add GitHub Action to sync OpenAPI spec to Postman on deploy
@KevinEdry KevinEdry force-pushed the add-api-key-instructions-page branch from 16153d8 to b509dbc Compare January 30, 2026 20:47
@lhagenWP lhagenWP merged commit 8724148 into main Jan 30, 2026
1 check passed
@KevinEdry KevinEdry deleted the add-api-key-instructions-page branch January 30, 2026 21:13
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.

2 participants