stack/docs/docs-platform.yml
Madison a5734defba
Adds oauth providers, fixes bottom page navigation with mobile suppor… (#726)
<!--

Fixes generation script, adds new oauth docs pages, fixes bottom
navigation, adds mobile support, sidebar changes.

-->

<!-- ELLIPSIS_HIDDEN -->


----

> [!IMPORTANT]
> This PR adds OAuth provider documentation, enhances mobile navigation,
and updates Python-specific documentation for Stack Auth.
> 
>   - **OAuth Providers**:
> - Adds documentation for GitHub, Google, Facebook, Microsoft, Spotify,
Discord, GitLab, Apple, Bitbucket, LinkedIn, and X (Twitter) in
`docs/templates/concepts/auth-providers/`.
> - Updates `docs/docs-platform.yml` to include new OAuth provider
pages.
>   - **Mobile Support**:
> - Enhances bottom navigation for mobile devices in
`docs/src/app/(home)/layout.tsx` and `docs/src/app/api/layout.tsx`.
> - Introduces `AIChatDrawer` and `AuthPanel` components for
mobile-friendly interactions.
>   - **Documentation Enhancements**:
> - Adds Python-specific documentation for user authentication and team
management in `docs/templates-python/concepts/`.
> - Updates `docs/templates-python/meta.json` to include new Python
documentation pages.
> - Refines search functionality and UI components for better user
experience.
> 
> <sup>This description was created by </sup>[<img alt="Ellipsis"
src="https://img.shields.io/badge/Ellipsis-blue?color=175173">](https://www.ellipsis.dev?ref=stack-auth%2Fstack-auth&utm_source=github&utm_medium=referral)<sup>
for bf759151d8. You can
[customize](https://app.ellipsis.dev/stack-auth/settings/summaries) this
summary. It will automatically update as commits are pushed.</sup>


<!-- ELLIPSIS_HIDDEN -->

---------

Co-authored-by: Konsti Wohlwend <n2d4xc@gmail.com>
2025-07-08 19:51:24 -07:00

273 lines
7.8 KiB
YAML

# Platform-specific content filtering configuration
# Explicit page-by-page listing approach
pages:
# Root pages
- path: overview.mdx
platforms: ["next", "react", "js", "python"]
- path: faq.mdx
platforms: ["next", "react", "js", "python"]
# Getting Started
- path: getting-started/setup.mdx
platforms: ["next", "react", "js", "python"]
- path: getting-started/components.mdx
platforms: ["next", "react"] # Only React-like platforms
- path: getting-started/users.mdx
platforms: ["next", "react", "js"] # No Python
- path: getting-started/example-pages.mdx
platforms: ["js"] # Only vanilla JS
# Auth Providers - Available for all platforms since OAuth is universal
- path: concepts/auth-providers/index.mdx
platforms: ["next", "react", "js", "python"]
- path: concepts/auth-providers/github.mdx
platforms: ["next", "react", "js", "python"]
- path: concepts/auth-providers/google.mdx
platforms: ["next", "react", "js", "python"]
- path: concepts/auth-providers/facebook.mdx
platforms: ["next", "react", "js", "python"]
- path: concepts/auth-providers/microsoft.mdx
platforms: ["next", "react", "js", "python"]
- path: concepts/auth-providers/spotify.mdx
platforms: ["next", "react", "js", "python"]
- path: concepts/auth-providers/discord.mdx
platforms: ["next", "react", "js", "python"]
- path: concepts/auth-providers/gitlab.mdx
platforms: ["next", "react", "js", "python"]
- path: concepts/auth-providers/apple.mdx
platforms: ["next", "react", "js", "python"]
- path: concepts/auth-providers/bitbucket.mdx
platforms: ["next", "react", "js", "python"]
- path: concepts/auth-providers/linkedin.mdx
platforms: ["next", "react", "js", "python"]
- path: concepts/auth-providers/x-twitter.mdx
platforms: ["next", "react", "js", "python"]
# Advanced auth methods - More frontend-focused
- path: getting-started/auth-providers/passkey.mdx
platforms: ["next", "react", "js"] # No Python (frontend feature)
- path: getting-started/auth-providers/two-factor-auth.mdx
platforms: ["next", "react", "js"] # No Python (frontend feature)
- path: getting-started/production.mdx
platforms: ["next", "react", "js"] # No Python
# Concepts
- path: concepts/stack-app.mdx
platforms: ["next", "react", "js"] # No Python
- path: concepts/custom-user-data.mdx
platforms: ["next", "react", "js"] # No Python
- path: concepts/user-onboarding.mdx
platforms: ["next", "react"] # No JS or Python
- path: concepts/oauth.mdx
platforms: ["next", "react", "js"] # No Python
- path: concepts/orgs-and-teams.mdx
platforms: ["next", "react", "js"] # No Python
- path: concepts/team-selection.mdx
platforms: ["next", "react", "js"] # No Python
- path: concepts/permissions.mdx
platforms: ["next", "react", "js"] # No Python
- path: concepts/api-keys.mdx
platforms: ["next", "react", "js"] # No Python
- path: concepts/webhooks.mdx
platforms: ["next", "react", "js"] # No Python
- path: concepts/backend-integration.mdx
platforms: ["next", "react", "js", "python"]
# Components (React-like only)
- path: components/overview.mdx
platforms: ["next", "react"]
- path: components/user-button.mdx
platforms: ["next", "react"]
- path: components/selected-team-switcher.mdx
platforms: ["next", "react"]
- path: components/account-settings.mdx
platforms: ["next", "react"]
- path: components/sign-in.mdx
platforms: ["next", "react"]
- path: components/sign-up.mdx
platforms: ["next", "react"]
- path: components/credential-sign-in.mdx
platforms: ["next", "react"]
- path: components/credential-sign-up.mdx
platforms: ["next", "react"]
- path: components/magic-link-sign-in.mdx
platforms: ["next", "react"]
- path: components/forgot-password.mdx
platforms: ["next", "react"]
- path: components/password-reset.mdx
platforms: ["next", "react"]
- path: components/oauth-button.mdx
platforms: ["next", "react"]
- path: components/oauth-button-group.mdx
platforms: ["next", "react"]
- path: components/stack-handler.mdx
platforms: ["next", "react"]
- path: components/stack-provider.mdx
platforms: ["next", "react"]
- path: components/stack-theme.mdx
platforms: ["next", "react"]
# Customization (React-like only)
- path: customization/dark-mode.mdx
platforms: ["next", "react"]
- path: customization/custom-styles.mdx
platforms: ["next", "react"]
- path: customization/internationalization.mdx
platforms: ["next", "react"]
- path: customization/custom-pages.mdx
platforms: ["next", "react"]
- path: customization/page-examples/index.mdx
platforms: ["next", "react"]
- path: customization/page-examples/sign-in.mdx
platforms: ["next", "react"]
- path: customization/page-examples/sign-up.mdx
platforms: ["next", "react"]
- path: customization/page-examples/forgot-password.mdx
platforms: ["next", "react"]
- path: customization/page-examples/password-reset.mdx
platforms: ["next", "react"]
# SDK Reference
- path: sdk/overview.mdx
platforms: ["next", "react", "js"] # No Python
- path: sdk/overview-new.mdx
platforms: ["next", "react", "js"] # No Python
- path: sdk/objects/stack-app.mdx
platforms: ["next", "react", "js"] # No Python
- path: sdk/objects/stack-app-test.mdx
platforms: ["next", "react", "js"] # No Python
- path: sdk/types/api-key.mdx
platforms: ["next", "react", "js"] # No Python
- path: sdk/types/connected-account.mdx
platforms: ["next", "react", "js"] # No Python
- path: sdk/types/contact-channel.mdx
platforms: ["next", "react", "js"] # No Python
- path: sdk/types/project.mdx
platforms: ["next", "react", "js"] # No Python
- path: sdk/types/team.mdx
platforms: ["next", "react", "js"] # No Python
- path: sdk/types/team-permission.mdx
platforms: ["next", "react", "js"] # No Python
- path: sdk/types/team-profile.mdx
platforms: ["next", "react", "js"] # No Python
- path: sdk/types/team-user.mdx
platforms: ["next", "react", "js"] # No Python
- path: sdk/types/user.mdx
platforms: ["next", "react", "js"] # No Python
# SDK Hooks (React-like only)
- path: sdk/hooks/use-stack-app.mdx
platforms: ["next", "react"] # No JS or Python
- path: sdk/hooks/use-user.mdx
platforms: ["next", "react"] # No JS or Python
# Snippets (utility files - exclude from Python)
- path: snippets/always-tab-codeblock.mdx
platforms: ["next", "react", "js"] # No Python
- path: snippets/big-divider.mdx
platforms: ["next", "react", "js"] # No Python
- path: snippets/divider.mdx
platforms: ["next", "react", "js"] # No Python
- path: snippets/get-user-or-parameter.mdx
platforms: ["next", "react", "js"] # No Python
- path: snippets/make-full-page.mdx
platforms: ["next", "react", "js"] # No Python
- path: snippets/stack-app-constructor-options-after-ssk.mdx
platforms: ["next", "react", "js"] # No Python
- path: snippets/stack-app-constructor-options-before-ssk.mdx
platforms: ["next", "react", "js"] # No Python
- path: snippets/use-on-server-callout.mdx
platforms: ["next", "react", "js"] # No Python
# Others
- path: others/self-host.mdx
platforms: ["next", "react", "js", "python"] # All platforms
- path: others/supabase.mdx
platforms: ["next"] # Next only
- path: others/cli-authentication.mdx
platforms: ["python"] # Python only
# Python-specific content from templates-python/
# Authentication section
- path: concepts/user-authentication.mdx
platforms: ["python"] # python only
- path: concepts/teams-management.mdx
platforms: ["python"] # python only