docs: add api-requests guide#823
Merged
illright merged 8 commits intofeature-sliced:masterfrom Jun 19, 2025
Merged
Conversation
There was a problem hiding this comment.
Pull Request Overview
Adds a centralized guide on where and how to organize API request logic and removes inline examples from other docs in favor of linking to the new guide.
- Moved detailed “where to store request” examples out of the auth guide into a standalone API-requests guide
- Removed an outdated auto-generation types section in the types guide
- Introduced
api-requests.mdwith shared and slice-specific patterns, client setup, and generator recommendations
Reviewed Changes
Copilot reviewed 3 out of 3 changed files in this pull request and generated 2 comments.
| File | Description |
|---|---|
| i18n/en/docusaurus-plugin-content-docs/current/guides/examples/types.md | Removed “Auto-generation of types” section |
| i18n/en/docusaurus-plugin-content-docs/current/guides/examples/auth.md | Replaced inline API‐request examples with a reference link |
| i18n/en/docusaurus-plugin-content-docs/current/guides/examples/api-requests.md | Added new guide covering shared/slice-specific request patterns |
Comments suppressed due to low confidence (2)
i18n/en/docusaurus-plugin-content-docs/current/guides/examples/types.md:431
- [nitpick] The removal of the auto-generation section removes guidance on handling generated types; consider linking to an external guide or summarizing key steps for regenerating types in a dedicated folder.
## Auto-generation of types
i18n/en/docusaurus-plugin-content-docs/current/guides/examples/api-requests.md:14
- [nitpick] Indent this list under 'A typical file structure would be:' by two spaces (e.g.
- 📂 shared) to ensure proper nesting and consistent markdown rendering.
- 📂 shared
illright
requested changes
Jun 1, 2025
Member
illright
left a comment
There was a problem hiding this comment.
I really like how the new page reads, great work! I have some concerns about how the other pages link to this one though — I'd like to see the link more naturally integrated into the narrative
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.
Background
Some guides on where to place API requests. I added only the English version first to gather feedback.