Add generated API documentation #59
Open
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
- Add tsx dev dependency for running TypeScript scripts - Add generate:api script that fetches API schema and SDK examples - Integrate generation into dev/start/build commands - Ignore generated API docs in .gitignore (rebuilt on deploy) Co-Authored-By: Claude Opus 4.5 <[email protected]>
TypeScript type definitions for API schema, endpoints, SDK examples, and utility functions for fetching and merging API data. Co-Authored-By: Claude Opus 4.5 <[email protected]>
Add Card component with variants: Card, CardHeader, CardTitle, CardDescription, CardContent, CardFooter, CardAction. Co-Authored-By: Claude Opus 4.5 <[email protected]>
Co-Authored-By: Claude Opus 4.5 <[email protected]>
Add foundational React components for API documentation: - WebSocketBadge: Visual indicator for WebSocket endpoints - PropertyRow: Display property name, type, and description - EndpointHeader: Header with method and path - ParameterList: List of endpoint parameters - ResponseExample: Code block for response examples - TypeReference: Display type information - EndpointCard: Card container for endpoints - SnippetTabs: Tabbed code snippets - CodeSnippet: Syntax-highlighted code display Co-Authored-By: Claude Opus 4.5 <[email protected]>
Add Stainless-style double-pane layout components: - MethodPage/MethodPageLeft/MethodPageRight: Two-column layout - MethodBadge: HTTP method badge with colors - MethodHeader: Endpoint title with method and path - PropertyTree: Expandable property documentation - SDKSelector: Language selector for code examples - CollapsibleSnippet: Expandable code block - SnippetPanel: Code snippet container Co-Authored-By: Claude Opus 4.5 <[email protected]>
- SnippetSelector: React component for selecting code language - CodeSnippets.astro: Astro wrapper for multi-language code blocks - Persists language preference to localStorage - Syncs selection across all code snippets on page Co-Authored-By: Claude Opus 4.5 <[email protected]>
Export all API documentation components (legacy and double-pane) from the central React components index for easy importing. Co-Authored-By: Claude Opus 4.5 <[email protected]>
Replace external API link with in-site API documentation pages: Overview, Exec, Checkpoints, Services, Proxy, Policy, Type Definitions. Co-Authored-By: Claude Opus 4.5 <[email protected]>
Update the LLMs full-text export to include the generated API documentation pages instead of the removed rest.mdx. Co-Authored-By: Claude Opus 4.5 <[email protected]>
Add comprehensive CSS for API documentation including: - HTTP method colors (GET, POST, PUT, DELETE, PATCH, WebSocket) - Double-pane layout with sticky code snippets - Property tree styling - Method badges and headers - Snippet container styling - Full-width page layout for API pages - Stainless-style snippet component styling Co-Authored-By: Claude Opus 4.5 <[email protected]>
kylemclaren
changed the title
Preview Deployment
Commit: |
Lighthouse Results
|
E2E Test Results✅ Tests success Ran against: https://pr-59-superfly-sprites-docs.fly.dev |
- Remove unused imports - Fix import ordering - Apply formatting fixes - Use optional chaining where appropriate - Fix useEffect dependency issues with useCallback - Remove non-null assertions Co-Authored-By: Claude Opus 4.5 <[email protected]>
- Remove overflow:hidden from .method-page-right - Remove overflow-y:auto and max-height from .code-snippets - Move overflow-hidden to only the code blocks section - Add explicit border-radius to header and code blocks The dropdown was being clipped by multiple overflow containers. Co-Authored-By: Claude Opus 4.5 <[email protected]>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Summary
Changes
Build Infrastructure
tsxdev dependency for TypeScript script executionscripts/generate-api-docs.tsthat fetches API schema and SDK examples from remote sourcesgenerate:apiinto dev/start/build commandssrc/content/docs/api/in .gitignoreComponents
Configuration
Test plan
pnpm devand verify API docs are generated/apiand verify documentation renders🤖 Generated with Claude Code