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

docs: move Getting Started to a single page #12478

Draft
wants to merge 11 commits into
base: main
Choose a base branch
from

Conversation

balazsorban44
Copy link
Member

@balazsorban44 balazsorban44 commented Jan 7, 2025

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

Copy link

vercel bot commented Jan 7, 2025

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 19, 2025 1:18pm
2 Skipped Deployments
Name Status Preview Comments Updated (UTC)
next-auth-docs ⬜️ Ignored (Inspect) Visit Preview Jan 19, 2025 1:18pm
proxy ⬜️ Ignored (Inspect) Visit Preview Jan 19, 2025 1:18pm

Copy link

github-actions bot commented Jan 7, 2025

Broken Link Checker

71 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
/reference/rest-api "REST API"
/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/database "database"
/errors "errors"
/warnings "warnings"
/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) /getting-started

Target Link Link Text
/reference/rest-api "REST API"
/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/database "database"
/errors "errors"
/warnings "warnings"
/about "examples"

17) /getting-started

Target Link Link Text
/reference/rest-api "REST API"
/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/database "database"
/errors "errors"
/warnings "warnings"
/about "examples"

18) /getting-started

Target Link Link Text
/reference/rest-api "REST API"
/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/database "database"
/errors "errors"
/warnings "warnings"
/about "examples"

19) /getting-started

Target Link Link Text
/reference/rest-api "REST API"
/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/database "database"
/errors "errors"
/warnings "warnings"
/about "examples"

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.

1 participant