stack/docs/lib/platform-config.ts
Madison 8c805a8b8f
[Docs][Util][Content] - refactor docs to single source (#919)
<!--

Make sure you've read the CONTRIBUTING.md guidelines:
https://github.com/stack-auth/stack-auth/blob/dev/CONTRIBUTING.md

-->

Removes Platform selection, moves docs to single /content folder and no
longer gens docs. Only API docs are generated here.

<!-- RECURSEML_SUMMARY:START -->
## High-level PR Summary
This PR makes significant changes to the documentation structure by
removing platform-specific content organization and consolidating docs
into a single `/content` folder. The primary goal is to simplify the
documentation architecture by eliminating the platform-specific routing
(Next.js, React, JavaScript, Python) and instead organizing content by
topic (guides, SDK, components) regardless of platform. The PR removes
platform selection functionality, platform-specific navigation, and the
automatic generation of platform-specific documentation pages. It
introduces a new docs tree filtering system that organizes content by
section rather than by platform. These changes should make the
documentation more maintainable and easier to navigate while focusing on
the content itself rather than platform-specific variations.

⏱️ Estimated Review Time: 30-90 minutes

<details>
<summary>💡 Review Order Suggestion</summary>

| Order | File Path |
|-------|-----------|
| 1 | `docs/package.json` |
| 2 | `docs/src/lib/docs-tree.ts` |
| 3 | `docs/src/lib/navigation-utils.ts` |
| 4 | `docs/src/components/homepage/iconHover.tsx` |
| 5 | `docs/src/components/sdk/overview.tsx` |
| 6 | `docs/src/components/layouts/shared/section-utils.ts` |
| 7 | `docs/src/components/layout/custom-search-dialog.tsx` |
| 8 | `docs/src/app/api/search/route.ts` |
| 9 | `docs/src/app/docs/[[...slug]]/page.tsx` |
| 10 | `docs/src/components/layouts/docs-header-wrapper.tsx` |
| 11 | `docs/src/components/layouts/docs-layout-router.tsx` |
| 12 | `docs/src/components/layouts/docs.tsx` |
| 13 | `package.json` |
</details>



[![Need help? Join our
Discord](https://img.shields.io/badge/Need%20help%3F%20Join%20our%20Discord-5865F2?style=plastic&logo=discord&logoColor=white)](https://discord.gg/n3SsVDAW6U)

<!-- RECURSEML_SUMMARY:END -->

<!-- This is an auto-generated comment: release notes by coderabbit.ai
-->
## Summary by CodeRabbit

* **Documentation**
* Added many new guides (auth providers, OAuth, JWT, API keys, emails,
webhooks, orgs/teams, permissions, onboarding, customization), expanded
SDK & component reference pages, examples, and navigation metadata.
* Switched docs to a simpler section-based, platform-agnostic structure
and improved getting-started and production checklists.

* **Developer Experience**
* Enhanced docs UX: improved code-example UI with platform/framework
selectors, theme-aware highlighted code blocks, image zoom, and a
centralized code-sample registry.
<!-- end of auto-generated comment: release notes by coderabbit.ai -->

---------

Co-authored-by: Konstantin Wohlwend <n2d4xc@gmail.com>
2025-10-20 12:42:46 -05:00

79 lines
2.1 KiB
TypeScript

/**
* Global Platform Configuration
*
* This file defines all supported platforms and frameworks across the documentation.
* This ensures consistency between code examples, platform selectors, and the header indicator.
*/
export type PlatformName = 'JavaScript' | 'Python';
export type FrameworkName = string;
export type PlatformConfig = {
name: PlatformName,
frameworks: FrameworkName[],
defaultFramework: FrameworkName,
}
/**
* All supported platforms and their frameworks
* Order matters - first platform/framework will be the default
*/
export const PLATFORMS: PlatformConfig[] = [
{
name: 'JavaScript',
frameworks: ['Next.js', 'React', 'Express', 'Node.js', 'Vanilla JavaScript'],
defaultFramework: 'Next.js',
},
{
name: 'Python',
frameworks: ['Django', 'FastAPI', 'Flask'],
defaultFramework: 'Django',
},
];
/**
* Default platform to select when no selection exists
*/
export const DEFAULT_PLATFORM: PlatformName = 'JavaScript';
export const DEFAULT_FRAMEWORK = 'Next.js';
/**
* Get all platform names
*/
export function getAllPlatformNames(): PlatformName[] {
return PLATFORMS.map(p => p.name);
}
/**
* Get frameworks for a specific platform
*/
export function getFrameworksForPlatform(platform: PlatformName): FrameworkName[] {
const config = PLATFORMS.find(p => p.name === platform);
return config?.frameworks ?? [];
}
/**
* Get default framework for a platform
*/
export function getDefaultFrameworkForPlatform(platform: PlatformName): FrameworkName {
const config = PLATFORMS.find(p => p.name === platform);
return config?.defaultFramework ?? '';
}
/**
* Check if a platform/framework combination is valid
*/
export function isValidPlatformFramework(platform: string, framework: string): boolean {
const config = PLATFORMS.find(p => p.name === platform);
if (!config) return false;
return config.frameworks.includes(framework);
}
/**
* Get platform config by name
*/
export function getPlatformConfig(platform: PlatformName): PlatformConfig | undefined {
return PLATFORMS.find(p => p.name === platform);
}