docs: move Getting Started to a single page

[balazsorban44]

Our documentation is currently hard to navigate and is spread in too many pages. This greatly simplifies things and removes some redundancy, hopefully also improving the search functionality to not return so many results from so many pages.

☕️ Reasoning

🧢 Checklist

• Documentation
• Tests
• Ready to be merged

🎫 Affected issues

📌 Resources

• Security guidelines
• Contributing guidelines
• Code of conduct
• Contributing to Open Source

[vercel]

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	Jan 7, 2025 6:54pm

2 Skipped Deployments

Name	Status	Preview	Comments	Updated (UTC)
next-auth-docs	⬜️ Ignored (Inspect)			Jan 7, 2025 6:54pm
proxy	⬜️ Ignored (Inspect)			Jan 7, 2025 6:54pm

[socket-security]

New and removed dependencies detected. Learn more about Socket for GitHub ↗︎

Package	New capabilities	Transitives	Size	Publisher
npm/@auth/[email protected]	environment Transitive: network	+6	4.9 MB	balazsorban
npm/@auth/[email protected]	None	0	28 kB	balazsorban
npm/@radix-ui/[email protected]	None	+4	90.8 kB	chancestrickland
npm/@radix-ui/[email protected]	None	+9	176 kB	chancestrickland
npm/@radix-ui/[email protected]	None	+36	1.71 MB	andy-hook, benoitgrelard, chancestrickland, ...3 more
npm/@radix-ui/[email protected]	None	+15	481 kB	chancestrickland
npm/@radix-ui/[email protected]	None	+1	36.9 kB	chancestrickland
npm/@types/[email protected]	None	0	13.9 kB	types
npm/@types/[email protected]	None	0	9.7 kB	types
npm/@types/[email protected]	None	0	37.9 kB	types
npm/@types/[email protected]	None	+2	1.69 MB	types
npm/@vercel/[email protected]	environment Transitive: network	+2	778 kB	vercel-release-bot
npm/[email protected]	environment Transitive: filesystem, shell	+8	2.66 MB	ai
npm/[email protected]	None	0	22.1 kB	joebell93
npm/[email protected]	None	0	8.55 kB	lukeed
npm/[email protected]	environment, filesystem, network Transitive: eval, unsafe	+68	2.18 MB	jonchurch
npm/[email protected]	None	0	19.6 MB	ericfennis
npm/[email protected]	eval Transitive: environment, filesystem, network	+8	181 kB	dougwilson
npm/[email protected]	environment Transitive: network	+5	3.45 MB	balazsorban
npm/[email protected]	Transitive: environment, eval, filesystem, shell	+45	1.46 GB	rauchg, timneutkens, vercel-release-bot
npm/[email protected]	environment, eval, filesystem	+50	6.84 MB	pug-bot
npm/[email protected]	environment	+3	4.63 MB	react-bot
npm/[email protected]	environment	+2	339 kB	react-bot
npm/[email protected]	environment	0	765 kB	dcas
npm/[email protected]	None	0	18.1 kB	thejameskyle
npm/[email protected]	environment, filesystem Transitive: network, shell, unsafe	+105	15.6 MB	adamwathan, malfaitrobin, reinink
npm/[email protected]	Transitive: environment, filesystem, network, shell	+28	241 MB	hirokiosame
npm/[email protected]	Transitive: environment, network	+18	3.79 MB	pi0

🚮 Removed packages: npm/@inkeep/[email protected], npm/@mikro-orm/[email protected], npm/@mikro-orm/[email protected], npm/@miniflare/[email protected], npm/@neondatabase/[email protected], npm/@next/[email protected], npm/@playwright/[email protected], npm/@preact/[email protected], npm/@prettier/[email protected], npm/@prisma/[email protected], npm/@prisma/[email protected], npm/@radix-ui/[email protected], npm/@radix-ui/[email protected], npm/@simplewebauthn/[email protected], npm/@solidjs/[email protected], npm/@supabase/[email protected], npm/@sveltejs/[email protected], npm/@sveltejs/[email protected], npm/@sveltejs/[email protected], npm/@sveltejs/[email protected], npm/@sveltejs/[email protected], npm/@types/[email protected], npm/@types/[email protected], npm/[email protected]

View full report↗︎

[github-actions]

Broken Link Checker

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

1) /

Target Link	Link Text
/getting-started/integrations	"More"

2) /getting-started/migrating-to-v5

Target Link	Link Text
/getting-started/installation	"Installation"
/getting-started/deployment	"Read more"
/getting-started/session-management/protecting	"Middleware docs"
/getting-started/database	"adapters page"

3) /getting-started

Target Link	Link Text
/getting-started/deployment	"Deployment"
/getting-started/session-management/protecting	"protecting resources"
/getting-started/authentication/oauth	"OAuthproviders"
/getting-started/authentication/email	"Email MagicLinks"
/getting-started/authentication/webauthn	"WebAuthn(Passkeys)"
/getting-started/typescript	"augment the Userinterface"
/getting-started/authentication/email	"when implementing magic links"
/getting-started/database	"database"
/about	"examples"

4) /guides/configuring-oauth-providers

Target Link	Link Text
/getting-started/authentication/oauth	"built-in OAuth providers"

5) /guides/configuring-github

Target Link	Link Text
/getting-started/installation	"installation instructions"
/getting-started/installation	"installation section"
/getting-started/deployment	"Deployment page"

6) /getting-started/providers/42-school

Target Link	Link Text
/getting-started/database	"database adapter"

7) /getting-started/providers/credentials

Target Link	Link Text
/getting-started/authentication/credentials	"Client-side Input Validation Example"

8) /getting-started/providers/sailpoint

Target Link	Link Text
/getting-started/database	"User table"

9) /guides/environment-variables

Target Link	Link Text
/getting-started/deployment	"Deployment"
/getting-started/authentication/oauth	"official OAuth provider"

10) /concepts/session-strategies

Target Link	Link Text
/getting-started/database	"officialdatabase adapters"

11) /guides/edge-compatibility

Target Link	Link Text
/getting-started/session-management/protecting	"session management docs"
/getting-started/session-management/protecting	"protecting your routes"

12) /guides/extending-the-session

Target Link	Link Text
/getting-started/typescript	"TypeScript"

13) /guides/role-based-access-control

Target Link	Link Text
/getting-started/session-management/protecting	"Middleware"
/getting-started/database	"Adapters: User model"
/getting-started/session-management/protecting	"Next.js: Middleware"
/getting-started/typescript	"TypeScript"

14) /guides/configuring-resend

Target Link	Link Text
/getting-started/installation	"installation instructions"
/getting-started/installation	"installation section"
/getting-started/deployment	"Deployment page"

15) /guides/creating-a-framework-integration

Target Link	Link Text
/getting-started/integrations	"list of integrations"

16) /concepts/database-models

Target Link	Link Text
/getting-started/authentication/oauth	"OAuth Provider"
/getting-started/authentication/email	"Email Provider"

17) /getting-started

Target Link	Link Text
/getting-started/deployment	"Deployment"
/getting-started/session-management/protecting	"protecting resources"
/getting-started/authentication/oauth	"OAuthproviders"
/getting-started/authentication/email	"Email MagicLinks"
/getting-started/authentication/webauthn	"WebAuthn(Passkeys)"
/getting-started/typescript	"augment the Userinterface"
/getting-started/authentication/email	"when implementing magic links"
/getting-started/database	"database"
/about	"examples"

18) /getting-started

Target Link	Link Text
/getting-started/deployment	"Deployment"
/getting-started/session-management/protecting	"protecting resources"
/getting-started/authentication/oauth	"OAuthproviders"
/getting-started/authentication/email	"Email MagicLinks"
/getting-started/authentication/webauthn	"WebAuthn(Passkeys)"
/getting-started/typescript	"augment the Userinterface"
/getting-started/authentication/email	"when implementing magic links"
/getting-started/database	"database"
/about	"examples"

19) /getting-started

Target Link	Link Text
/getting-started/deployment	"Deployment"
/getting-started/session-management/protecting	"protecting resources"
/getting-started/authentication/oauth	"OAuthproviders"
/getting-started/authentication/email	"Email MagicLinks"
/getting-started/authentication/webauthn	"WebAuthn(Passkeys)"
/getting-started/typescript	"augment the Userinterface"
/getting-started/authentication/email	"when implementing magic links"
/getting-started/database	"database"
/about	"examples"

20) /getting-started

Target Link	Link Text
/getting-started/deployment	"Deployment"
/getting-started/session-management/protecting	"protecting resources"
/getting-started/authentication/oauth	"OAuthproviders"
/getting-started/authentication/email	"Email MagicLinks"
/getting-started/authentication/webauthn	"WebAuthn(Passkeys)"
/getting-started/typescript	"augment the Userinterface"
/getting-started/authentication/email	"when implementing magic links"
/getting-started/database	"database"
/about	"examples"