Skip to content

docs: add api-requests guide#823

Merged
illright merged 8 commits intofeature-sliced:masterfrom
Solant:feat/api-docs
Jun 19, 2025
Merged

docs: add api-requests guide#823
illright merged 8 commits intofeature-sliced:masterfrom
Solant:feat/api-docs

Conversation

@Solant
Copy link
Copy Markdown
Contributor

@Solant Solant commented May 22, 2025

Background

Some guides on where to place API requests. I added only the English version first to gather feedback.

@illright illright requested a review from Copilot June 1, 2025 09:13
Copy link
Copy Markdown

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.md with 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

Comment thread i18n/en/docusaurus-plugin-content-docs/current/guides/examples/auth.md Outdated
Comment thread i18n/en/docusaurus-plugin-content-docs/current/guides/examples/api-requests.md Outdated
Copy link
Copy Markdown
Member

@illright illright left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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

Comment thread i18n/en/docusaurus-plugin-content-docs/current/guides/examples/api-requests.md Outdated
Comment thread i18n/en/docusaurus-plugin-content-docs/current/guides/examples/api-requests.md Outdated
Comment thread i18n/en/docusaurus-plugin-content-docs/current/guides/examples/auth.md Outdated
@Solant Solant marked this pull request as ready for review June 10, 2025 22:24
@Solant Solant requested a review from illright June 17, 2025 08:44
Copy link
Copy Markdown
Member

@illright illright left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Great stuff, thanks!

@illright illright merged commit 49d42ad into feature-sliced:master Jun 19, 2025
2 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants