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

chore(docs): enhance API reference description for next-auth/react #11874

Merged

Conversation

halvaradop
Copy link
Contributor

@halvaradop halvaradop commented Sep 19, 2024

☕️ Reasoning

This pull request enhances the API reference for next-auth/react by adding detailed installation and usage sections.

On other hand, I would like to contribute to improving the API references for next-auth/react. However, I encountered an issue where the file cannot be found when I navigate to it, even though it does exist.

🧢 Checklist

  • Documentation
  • Tests
  • Ready to be merged

🎫 Affected issues

📌 Resources

Copy link

vercel bot commented Sep 19, 2024

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Comments Updated (UTC)
auth-docs ✅ Ready (Inspect) Visit Preview 💬 Add feedback Sep 25, 2024 8:35am
1 Skipped Deployment
Name Status Preview Comments Updated (UTC)
next-auth-docs ⬜️ Ignored (Inspect) Visit Preview Sep 25, 2024 8:35am

Copy link

vercel bot commented Sep 19, 2024

@halvaradop is attempting to deploy a commit to the authjs Team on Vercel.

A member of the Team first needs to authorize it.

Copy link

codecov bot commented Sep 19, 2024

Codecov Report

Attention: Patch coverage is 0% with 4 lines in your changes missing coverage. Please review.

Project coverage is 38.78%. Comparing base (16c5756) to head (328be7e).
Report is 15 commits behind head on main.

Files with missing lines Patch % Lines
packages/next-auth/src/react.tsx 0.00% 4 Missing ⚠️
Additional details and impacted files
@@            Coverage Diff             @@
##             main   #11874      +/-   ##
==========================================
- Coverage   38.78%   38.78%   -0.01%     
==========================================
  Files         189      189              
  Lines       29818    29825       +7     
  Branches     1272     1280       +8     
==========================================
+ Hits        11565    11567       +2     
- Misses      18253    18258       +5     

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

Copy link
Member

@balazsorban44 balazsorban44 left a comment

Choose a reason for hiding this comment

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

Thanks!

packages/next-auth/src/react.tsx Outdated Show resolved Hide resolved
packages/next-auth/src/react.tsx Outdated Show resolved Hide resolved
packages/next-auth/src/react.tsx Outdated Show resolved Hide resolved
@balazsorban44 balazsorban44 merged commit 2f8320c into nextauthjs:main Sep 25, 2024
8 of 10 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants