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): tweak intro paragraph copy #10808

Merged
merged 4 commits into from May 4, 2024
Merged

Conversation

ndom91
Copy link
Member

@ndom91 ndom91 commented May 3, 2024

☕️ Reasoning

  • Improve the intro paragraph a bit
  • Add an <abbr> element to show definition on the "technical term" runtime agnostic

Copy

Auth.js is a runtime agnostic library based on standard Web APIs that integrates deeply with multiple modern JavaScript frameworks to provide an authentication experience that’s simple to get started with, easy to extend, and always private and secure!

This documentation covers next-auth@5.0.0-beta and later and all other frameworks under the @auth/* namespace. Documentation for next-auth@4.x.y can still be found at next-auth.js.org.

What do yall think? Open to changing the copy of course if anyone else has good suggestions 🙏. I do think the <abbr> thing is a good idea for more technical terms though.

Screenshots

image

image

🧢 Checklist

  • Documentation
  • Tests
  • Ready to be merged

🎫 Affected issues

Fixes: #10584

📌 Resources

@ndom91 ndom91 requested a review from ubbe-xyz as a code owner May 3, 2024 10:57
Copy link

vercel bot commented May 3, 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 May 4, 2024 10:25am
2 Ignored Deployments
Name Status Preview Comments Updated (UTC)
next-auth-docs ⬜️ Ignored (Inspect) Visit Preview May 4, 2024 10:25am
proxy ⬜️ Ignored (Inspect) Visit Preview May 4, 2024 10:25am

Copy link

codecov bot commented May 3, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 41.12%. Comparing base (6e36083) to head (16f342e).

❗ Current head 16f342e differs from pull request most recent head d32cbd2. Consider uploading reports for the commit d32cbd2 to get more accurate results

Additional details and impacted files
@@           Coverage Diff           @@
##             main   #10808   +/-   ##
=======================================
  Coverage   41.12%   41.12%           
=======================================
  Files         173      173           
  Lines       28471    28471           
  Branches     1173     1173           
=======================================
  Hits        11710    11710           
  Misses      16761    16761           

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

Copy link

github-actions bot commented May 3, 2024

Broken Link Checker

1 broken links found. Links organised below by source page, or page where they were found.

1) /concepts/database-models

Target Link Link Text
/reference/core/providers/oauth "OAuth Provider"

@ndom91 ndom91 merged commit 1902ba9 into main May 4, 2024
8 of 11 checks passed
@ndom91 ndom91 deleted the ndom91/tweak-docs-intro-paragraph branch May 4, 2024 10:22
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.

Improve Auth.js Intro
1 participant