Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[Content]: Remove the useSubmission/useSubmissions section in the action reference #1003

Open
amirhhashemi opened this issue Jan 3, 2025 · 0 comments
Assignees
Labels
pending review Awaiting review by team members.

Comments

@amirhhashemi
Copy link
Contributor

amirhhashemi commented Jan 3, 2025

📚 Subject area/topic

Reference

📋 Page(s) affected (or suggested, for new content)

https://docs.solidjs.com/solid-router/reference/data-apis/action

📋 Description of content that is out-of-date or incorrect

I think the section on useSubmission/useSubmissions in the action reference page is a bit unnecessary for a few reasons:

  1. Both useSubmission and useSubmissions already have their own detailed reference pages.
  2. The description there doesn’t really do them justice. They're not just for optimistic updates; they can also handle errors and show pending UI. It’d make more sense to put that info in other guides or reference pages.
  3. I checked out the Diataxis Reference Guide (which I assume you use it a reference for writing reference pages), and it says not to mix explanations in reference pages. This section feels more like an explanation to me.

So, I suggest we just remove this section.

Feel free to assign this task to me if you wish.

🖥️ Reproduction in StackBlitz (if reporting incorrect content or code samples)

No response

@amirhhashemi amirhhashemi added the pending review Awaiting review by team members. label Jan 3, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
pending review Awaiting review by team members.
Projects
None yet
Development

No branches or pull requests

2 participants