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

Update outdated docs, improve naming, prefer user props over auth hook in docs #2535

Merged
merged 8 commits into from
Mar 21, 2025

Conversation

FranjoMindek
Copy link
Contributor

  • Adds await for sanitizeAndSerializeProviderData calls
  • Renames data-model/backends to data-model/databases
  • Docs guide users to use user props rather than useAuth(), also reflected on examples

Related issues: #2514, #1071

@FranjoMindek FranjoMindek added the documentation Improvements or additions to documentation label Mar 6, 2025
Copy link
Member

@Martinsos Martinsos left a comment

Choose a reason for hiding this comment

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

Looks good to me! I will leave approving to @infomiho though, since he knows the Auth part better.

@@ -8,6 +8,7 @@
/docs/deploying /docs/deployment/intro 301
/docs/advanced/deployment/overview /docs/deployment/intro 301
/docs/integrations/css-frameworks /docs/project/css-frameworks 301
/docs/data-model/backends /docs/data-model/databases 301
Copy link
Member

Choose a reason for hiding this comment

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

Hm but this is probably not 1 on 1 mapping? I am guessing that backends was wider than just databases? If it is just name change then makews sense, but if not and backends was wider, maybe better not to map at all?

Copy link
Contributor

Choose a reason for hiding this comment

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

It's fine - the backends refered to "database backends". The new "databases" site is exactly that with a couple of extra sentences and an extra title added on top.

@@ -8,6 +8,7 @@
/docs/deploying /docs/deployment/intro 301
/docs/advanced/deployment/overview /docs/deployment/intro 301
/docs/integrations/css-frameworks /docs/project/css-frameworks 301
/docs/data-model/backends /docs/data-model/databases 301
Copy link
Contributor

Choose a reason for hiding this comment

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

It's fine - the backends refered to "database backends". The new "databases" site is exactly that with a couple of extra sentences and an extra title added on top.

@Martinsos
Copy link
Member

@FranjoMindek did I get something wrong, or did you add quite some changes after my last review -> what happened there? Are those still in the initial scope of this PR, or are these additional fixes?

@FranjoMindek
Copy link
Contributor Author

Initial commit didn't capture all places referencing the old name of the document. I've added rest of them.
Filip also wanted to word things a bit differently so I've added those too.
Lastly, we found mentions of "wasp-lang" instead of wasp in some old document so Filip said I should fix those too.

Copy link
Contributor

@sodic sodic left a comment

Choose a reason for hiding this comment

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

Nice work. I'm approving but left some suggestions

@FranjoMindek FranjoMindek self-assigned this Mar 19, 2025
@FranjoMindek FranjoMindek merged commit 46cf281 into release Mar 21, 2025
6 checks passed
@FranjoMindek FranjoMindek deleted the rf/docs branch March 21, 2025 14:57
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

sanitizeAndSerializeProviderData is missing await in seeding docs Improve docs on the session prop
4 participants