claude/improve-prism-docs-VH8qW#5
Merged
Merged
Conversation
- prism-framework-ui README: rewrite to match the actual exports; the
previous README referenced a nonexistent QueryProvider, a missing
React Query integration, and unexported Radix UI components.
- Clarify the /api/ path prefix rule: HTTP callers (including
`prism call`, webFetch, and `prism generate-api-clients`) need /api/
in the URL, but `createEndpoint({ path })` must not include it. Fixed
the README, endpoint-tools, source-directory-organization, and
vite-setup examples accordingly.
- Fix the creating-mobile-apps cross-platform comparison table: desktop
auth uses the `getAuth` option, not Express middleware.
- Fix the MigrationBehavior values listed in launch-configuration and
database-setup to match the real values (`strict`, `safe-upgrades`,
`full-destructive-updates`, `ignore`).
- Correct authorization to handle the
`getCurrentRequestContext() === undefined` case and describe what
`requires: ['authenticated-user']` actually does (metadata only; the
base framework does not auto-reject).
- generate-api-clients-config: reference `/api/openapi.json` and the
`port-assignment`-based port resolution.
- Expand overview and the README doc index to mention previously
undocumented guides (creating-mobile-apps, cors-setup, error-handling,
generate-api-clients-config, metrics, source-directory-organization).
- vite-setup: proxy only `/api`, and document the matching webFetch
usage that includes `/api` in the path (or in `baseUrl`).
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
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.
previous README referenced a nonexistent QueryProvider, a missing
React Query integration, and unexported Radix UI components.
prism call, webFetch, andprism generate-api-clients) need /api/in the URL, but
createEndpoint({ path })must not include it. Fixedthe README, endpoint-tools, source-directory-organization, and
vite-setup examples accordingly.
auth uses the
getAuthoption, not Express middleware.database-setup to match the real values (
strict,safe-upgrades,full-destructive-updates,ignore).getCurrentRequestContext() === undefinedcase and describe whatrequires: ['authenticated-user']actually does (metadata only; thebase framework does not auto-reject).
/api/openapi.jsonand theport-assignment-based port resolution.undocumented guides (creating-mobile-apps, cors-setup, error-handling,
generate-api-clients-config, metrics, source-directory-organization).
/api, and document the matching webFetchusage that includes
/apiin the path (or inbaseUrl).