docs: Fix typo "Bold" → "Boild" and enhance documentation #25
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
Contributor
owjs3901
commented
Dec 19, 2025
owjs3901
commented
- Fix typo: "Bold Typing" → "Boild Typing" (named after "boiled" - the warm opposite of cold, inspired by "boilerplate")
- Add comprehensive Table of Contents to README
- Improve Quick Start section with collapsible details and step-by-step guide
- Expand API Usage examples:
- Add PUT/PATCH/DELETE request examples
- Add error handling patterns
- Add request interceptors
- Add timeout and retry logic examples
- Enhance React Query integration section:
- Add setup instructions with QueryClientProvider
- Add useQuery examples with query options
- Add useMutation examples with optimistic updates
- Add useInfiniteQuery with pagination and infinite scroll
- Add dependent queries pattern
- Add new Advanced Usage section:
- Authentication & JWT token refresh flow
- File upload (single and multiple with progress)
- Request cancellation with AbortController
- Logging & debugging
- Caching strategy
- Rate limiting
- Environment-based base URL
- Update SKILL.md with Boild typing terminology and advanced features note
- Fix typo: "Bold Typing" → "Boild Typing" (named after "boiled" - the warm opposite of cold, inspired by "boilerplate") - Add comprehensive Table of Contents to README - Improve Quick Start section with collapsible details and step-by-step guide - Expand API Usage examples: - Add PUT/PATCH/DELETE request examples - Add error handling patterns - Add request interceptors - Add timeout and retry logic examples - Enhance React Query integration section: - Add setup instructions with QueryClientProvider - Add useQuery examples with query options - Add useMutation examples with optimistic updates - Add useInfiniteQuery with pagination and infinite scroll - Add dependent queries pattern - Add new Advanced Usage section: - Authentication & JWT token refresh flow - File upload (single and multiple with progress) - Request cancellation with AbortController - Logging & debugging - Caching strategy - Rate limiting - Environment-based base URL - Update SKILL.md with Boild typing terminology and advanced features note
Changepacks@devup-api/[email protected] → 0.1.10 - packages/generator/package.jsonPatch
|
Fixed all examples that incorrectly used custom `fetch` function parameter: - Authentication: Now uses api.use() with onRequest middleware for JWT token injection - Token Refresh Flow: Uses onRequest and onResponse middleware for automatic token refresh - Request Cancellation: Uses signal parameter in api.get() options - Timeout Configuration: Uses middleware with AbortController - Retry Logic: Uses onResponse middleware for retry on server errors - Logging & Debugging: Uses onRequest/onResponse middleware - Caching Strategy: Uses onRequest middleware to return cached responses - Rate Limiting: Uses onRequest middleware with rate limiter Removed duplicate "Request Interceptors" section (functionality covered by Middleware examples) All examples now correctly demonstrate devup-api's Middleware API pattern as shown in test files.
Changed all occurrences of the incorrect option name: - openapiFile (❌ singular) → openapiFiles (✅ plural) - Updated type to string | string[] to support multiple OpenAPI schemas - Fixed Quick Start examples (Vite, Webpack, Rsbuild) - Fixed Configuration Options section with correct type signature The actual option name in the codebase is openapiFiles (plural), as defined in: - packages/core/src/options.ts - packages/utils/src/read-openapi.ts (normalizeOpenapiFiles function)
Removed the Timeout Middleware example that was not found in the codebase: - The pattern was unverified and potentially had memory leaks (no timeout cleanup) - Used unnecessary middleware complexity Replaced with correct approach using signal option directly: - DevupApiRequestInit extends RequestInit, so signal is natively supported - Added two examples: wrapper function and direct signal usage - Includes proper timeout cleanup with clearTimeout() - Simpler, clearer, and verified approach This matches how React Query integration uses signal (see packages/react-query/src/query-client.ts:88-94)
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.