Improve API documentation #284
Merged
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
|
Thanks @romalytvynenko! |
jbrooksuk
added a commit
that referenced
this pull request
Aug 18, 2025
* main: Add "Under maintenance" status to components and systems (#287) Filament v4 (#292) Compile Assets Fix Incident and Updates message size (#290) Bump some dependencies Updated language files (German & Dutch) (#281) Add demo server fix; Missing webhook events in WebhookListener list (#283) Improve API documentation (#284) Use app context Fix code styling Allow configuring whether to use external dependencies (#278) Don't call pint on every test run
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.
This PR improves API documentation generation by updating Scramble dependencies and introducing a new step in the docs-building GitHub Action.
The Scramble updates fix several issues related to closely following the JSON:API specification and introduce automatic type inference for
*paginatecalls, allowing the removal of some manual annotations.The new step in the GitHub Action sets up the environment — specifically the database — before building the documentation. This enables Scramble to use database information to accurately infer the types of resource attributes.