docs: Improve clarity and consistency across documentation - #22
Merged
Conversation
- Enhanced explanations in the reading-data.md to clarify resource serialization and customization. - Updated reference.md for better understanding of the jsonApi context helper and its components. - Revised what-is-jsonapi.md to provide clearer insights into the JSON:API specification and its benefits. - Clarified writing-data.md to better describe resource creation, updates, and relationship endpoints. - Improved blog example README.md for better readability and understanding of the example application.
…cal English Restructure the documentation into task-scoped guides. Split the old reading-data guide into resources, queries, and scopes. Add concepts and getting-started. Remove what-is-jsonapi, reading-data, and writing-data. Author each guide from the source code rather than the previous prose, so every claim traces to src or the example app. Correct several facts: hasOne relationship writes return 403 (not 405), document the exact meta.page fields, the top-level links.self on single documents, and the serializeAs: null password case. Apply ASD-STE100 Simplified Technical English throughout: short sentences, plain vocabulary, active voice, and condition before command.
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
1 participant
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.
No description provided.