From 09cefbedbf3a9069eef4b625d6cc103cfbc346c2 Mon Sep 17 00:00:00 2001 From: Tim <135014430+nagisa77@users.noreply.github.com> Date: Tue, 9 Sep 2025 13:48:26 +0800 Subject: [PATCH] feat(docs): remove path prefix --- CONTRIBUTING.md | 2 +- docs/README.md | 6 +++--- docs/app/{docs => }/(home)/[[...slug]]/page.tsx | 4 ++-- docs/app/{docs => }/(home)/layout.tsx | 8 ++++---- docs/app/layout.tsx | 2 +- docs/content/docs/backend/index.mdx | 2 +- docs/content/docs/index.mdx | 6 +++--- docs/lib/layout.shared.tsx | 2 +- docs/lib/source.ts | 2 +- 9 files changed, 17 insertions(+), 17 deletions(-) rename docs/app/{docs => }/(home)/[[...slug]]/page.tsx (93%) rename docs/app/{docs => }/(home)/layout.tsx (91%) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 980a94d07..f48124216 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -249,6 +249,6 @@ https://resend.com/emails 创建账号并登录 ## 开源共建和API文档 -- API文档: https://openisle-docs.netlify.app/docs/openapi +- API文档: https://openisle-docs.netlify.app/openapi diff --git a/docs/README.md b/docs/README.md index f74870a2c..b6b4b3ea3 100644 --- a/docs/README.md +++ b/docs/README.md @@ -16,6 +16,6 @@ bun dev 使用以下路由： -- `docs/frontend/` 前端技术文档 -- `docs/backend/` 后端技术文档 -- `docs/openapi/` 后端 API 文档 +- `frontend/` 前端技术文档 +- `backend/` 后端技术文档 +- `openapi/` 后端 API 文档 diff --git a/docs/app/docs/(home)/[[...slug]]/page.tsx b/docs/app/(home)/[[...slug]]/page.tsx similarity index 93% rename from docs/app/docs/(home)/[[...slug]]/page.tsx rename to docs/app/(home)/[[...slug]]/page.tsx index d509f6d9c..2a24c0f1b 100644 --- a/docs/app/docs/(home)/[[...slug]]/page.tsx +++ b/docs/app/(home)/[[...slug]]/page.tsx @@ -19,7 +19,7 @@ function DocsCategory({ url }: { url: string }) { ); } -export default async function Page(props: PageProps<'/docs/[[...slug]]'>) { +export default async function Page(props: PageProps<'/[[...slug]]'>) { const params = await props.params; const page = source.getPage(params.slug); if (!page) notFound(); @@ -48,7 +48,7 @@ export async function generateStaticParams() { } export async function generateMetadata( - props: PageProps<'/docs/[[...slug]]'> + props: PageProps<'/[[...slug]]'> ): Promise { const params = await props.params; const page = source.getPage(params.slug); diff --git a/docs/app/docs/(home)/layout.tsx b/docs/app/(home)/layout.tsx similarity index 91% rename from docs/app/docs/(home)/layout.tsx rename to docs/app/(home)/layout.tsx index bff29e164..5380d48a8 100644 --- a/docs/app/docs/(home)/layout.tsx +++ b/docs/app/(home)/layout.tsx @@ -28,7 +28,7 @@ function TabTitle({ children }: { children: React.ReactNode }) { return {children}; } -export default function Layout({ children }: LayoutProps<'/docs'>) { +export default function Layout({ children }: LayoutProps<'/'>) { return ( // @ts-ignore ) { { title: 'OpenIsle 前端', description: 前端开发文档, - url: '/docs/frontend', + url: '/frontend', icon: ( @@ -50,7 +50,7 @@ export default function Layout({ children }: LayoutProps<'/docs'>) { { title: 'OpenIsle 后端', description: 后端开发文档, - url: '/docs/backend', + url: '/backend', icon: ( @@ -60,7 +60,7 @@ export default function Layout({ children }: LayoutProps<'/docs'>) { { title: 'OpenIsle API', description: 后端 API 文档, - url: '/docs/openapi', + url: '/openapi', icon: ( diff --git a/docs/app/layout.tsx b/docs/app/layout.tsx index 0c57627a2..3aaa91604 100644 --- a/docs/app/layout.tsx +++ b/docs/app/layout.tsx @@ -6,7 +6,7 @@ const inter = Inter({ subsets: ['latin'], }); -export default function Layout({ children }: LayoutProps<'/docs'>) { +export default function Layout({ children }: LayoutProps<'/'>) { return ( diff --git a/docs/content/docs/backend/index.mdx b/docs/content/docs/backend/index.mdx index 1eac19a6c..d9613e03d 100644 --- a/docs/content/docs/backend/index.mdx +++ b/docs/content/docs/backend/index.mdx @@ -40,4 +40,4 @@ backend/ ## API 接口 -详细的 API 接口文档请查看 [API 文档](/docs/openapi)。 +详细的 API 接口文档请查看 [API 文档](/openapi)。 diff --git a/docs/content/docs/index.mdx b/docs/content/docs/index.mdx index e808a0964..23316bf67 100644 --- a/docs/content/docs/index.mdx +++ b/docs/content/docs/index.mdx @@ -9,6 +9,6 @@ OpenIsle 是一个现代化的社区平台，提供完整的社交功能。 ## 快速开始 -- [后端开发指南](/docs/backend) - 了解后端架构和开发 -- [前端开发指南](/docs/frontend) - 了解前端技术栈和组件 -- [API 文档](/docs/openapi) - 查看完整的 API 接口文档 +- [后端开发指南](/backend) - 了解后端架构和开发 +- [前端开发指南](/frontend) - 了解前端技术栈和组件 +- [API 文档](/openapi) - 查看完整的 API 接口文档 diff --git a/docs/lib/layout.shared.tsx b/docs/lib/layout.shared.tsx index 048c2c457..1e7f9faf5 100644 --- a/docs/lib/layout.shared.tsx +++ b/docs/lib/layout.shared.tsx @@ -8,7 +8,7 @@ export function baseOptions(): BaseLayoutProps { githubUrl: 'https://github.com/nagisa77/OpenIsle', nav: { title: 'OpenIsle Docs', - url: '/docs', + url: '/', }, searchToggle: { enabled: false, diff --git a/docs/lib/source.ts b/docs/lib/source.ts index eacde81fd..5fe372178 100644 --- a/docs/lib/source.ts +++ b/docs/lib/source.ts @@ -10,7 +10,7 @@ import * as ClientAdapters from './media-adapter.client'; // See https://fumadocs.vercel.app/docs/headless/source-api for more info export const source = loader({ // it assigns a URL to your pages - baseUrl: '/docs', + baseUrl: '/', source: docs.toFumadocsSource(), pageTree: { transformers: [transformerOpenAPI()],