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.

Sign up for GitHub

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

Jump to bottom

docs(adapters): source content + overview #7023

Merged
merged 8 commits into from
Mar 21, 2023
Merged

docs(adapters): source content + overview #7023

merged 8 commits into from
Mar 21, 2023

Conversation

ubbe-xyz
Copy link
Collaborator

@ubbe-xyz ubbe-xyz commented Mar 21, 2023 •
edited

☕️ Reasoning

This PR is an effort to finally clean up our adapters docs 😪 🥵 ; it englobes to significant changes:

  • Move all the remaining adapters content to the source code ( via Typedoc )
  • Adapt the adapter pages to have a similar content architecture ( basically look similar )
  • Create an overview page where the user can easily navigate to the pages

image

image

image

🧢 Checklist

  • Documentation
  • Tests
  • Ready to be merged

🎫 Affected issues

None

📌 Resources

@ubbe-xyz ubbe-xyz added the documentation Relates to documentation label Mar 21, 2023
@ubbe-xyz ubbe-xyz requested a review from ndom91 as a code owner March 21, 2023 16:04
@vercel
Copy link

vercel bot commented Mar 21, 2023 •
edited

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

Name Status Preview Comments Updated
auth-docs ✅ Ready (Inspect) Visit Preview 💬 1 unresolved
✅ 1 resolved		 Mar 21, 2023 at 6:23PM (UTC)
auth-docs-nextra ❌ Failed (Inspect) Mar 21, 2023 at 6:23PM (UTC)
1 Ignored Deployment
Name Status Preview Comments Updated
next-auth-docs ⬜️ Ignored (Inspect) Mar 21, 2023 at 6:23PM (UTC)

@github-actions github-actions bot added adapters Changes related to the core code concerning database adapters dgraph @auth/dgraph-adapter dynamodb @auth/dynamodb-adapter fauna @auth/fauna-adapter firebase @auth/firebase-adapter mikro-orm @auth/mikro-orm-adapter mongodb @auth/mongodb-adapter neo4j @auth/neo4j-adapter pouchdb @auth/pouchdb-adapter prisma @auth/prisma-adapter sequelize @auth/sequelize-adapter supabase @auth/supabase-adapter typeorm-legacy upstash-redis @auth/upstash-redis-adapter xata @auth/xata-adapter and removed documentation Relates to documentation labels Mar 21, 2023
@balazsorban44
Copy link
Member

General feedback/good to know. Docs links inside packages need to be absolute (prefixed with https://authjs.dev) so they work in IDEs.

@balazsorban44 balazsorban44 merged commit 1d9b9ba into main Mar 21, 2023
1 check passed
@balazsorban44 balazsorban44 deleted the docs/mikro-orm-content branch March 21, 2023 18:26
@balazsorban44 balazsorban44 mentioned this pull request Mar 24, 2023
Closed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@balazsorban44 balazsorban44 balazsorban44 left review comments

@ndom91 ndom91 Awaiting requested review from ndom91 ndom91 is a code owner

Assignees
No one assigned
Labels
adapters Changes related to the core code concerning database adapters dgraph @auth/dgraph-adapter dynamodb @auth/dynamodb-adapter fauna @auth/fauna-adapter firebase @auth/firebase-adapter mikro-orm @auth/mikro-orm-adapter mongodb @auth/mongodb-adapter neo4j @auth/neo4j-adapter pouchdb @auth/pouchdb-adapter prisma @auth/prisma-adapter sequelize @auth/sequelize-adapter supabase @auth/supabase-adapter typeorm-legacy upstash-redis @auth/upstash-redis-adapter xata @auth/xata-adapter
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

None yet
2 participants
@ubbe-xyz @balazsorban44