docs: update api-reference project for v2 (#7307)

* remove everything v1 and make v2 default

* move main v2 rewrites to book

* move rewrites to book + other fixes
This commit is contained in:
Shahed Nasser
2024-05-16 09:02:35 +02:00
committed by GitHub
parent 9b1998b9b2
commit 22f30f54fd
2148 changed files with 8965 additions and 140283 deletions
+2 -2
View File
@@ -21,8 +21,8 @@ const AreaProvider = ({ area: passedArea, children }: AreaProviderProps) => {
const { defaultFilters, setDefaultFilters } = useSearch()
useEffect(() => {
if (!defaultFilters.includes(area)) {
setDefaultFilters([area])
if (!defaultFilters.includes(`${area}-v2`)) {
setDefaultFilters([`${area}-v2`])
}
}, [area, defaultFilters, setDefaultFilters])
+1 -4
View File
@@ -12,7 +12,6 @@ import {
import BaseSpecsProvider from "./base-specs"
import SidebarProvider from "./sidebar"
import SearchProvider from "./search"
import VersionProvider from "./version"
import { config } from "../config"
type ProvidersProps = {
@@ -30,9 +29,7 @@ const Providers = ({ children }: ProvidersProps) => {
<ScrollControllerProvider scrollableSelector="#main">
<SidebarProvider>
<SearchProvider>
<MobileProvider>
<VersionProvider>{children}</VersionProvider>
</MobileProvider>
<MobileProvider>{children}</MobileProvider>
</SearchProvider>
</SidebarProvider>
</ScrollControllerProvider>
+10 -34
View File
@@ -3,11 +3,10 @@
import {
usePageLoading,
SearchProvider as UiSearchProvider,
AiAssistantCommandIcon,
AiAssistantProvider,
searchFiltersV1,
searchFiltersV2,
} from "docs-ui"
import { config } from "../config"
import basePathUrl from "../utils/base-path-url"
type SearchProviderProps = {
children: React.ReactNode
@@ -33,49 +32,26 @@ const SearchProvider = ({ children }: SearchProviderProps) => {
title: "Getting started? Try one of the following terms.",
items: [
"Install Medusa with create-medusa-app",
"Next.js quickstart",
"Admin dashboard quickstart",
"Commerce modules",
"Medusa architecture",
"What is an API route?",
"What is a Module?",
"What is a Workflow?",
],
},
{
title: "Developing with Medusa",
items: [
"Recipes",
"How to create API routes",
"How to create an entity",
"How to create a plugin",
"How to create a Module",
"How to create an API route",
"How to create a data model",
"How to create an admin widget",
],
},
],
checkInternalPattern: new RegExp(
`^${config.baseUrl}/api/(admin|store)`
`^${config.baseUrl}${basePathUrl("/api/(admin|store)")}`
),
filterOptions: searchFiltersV1,
filterOptions: searchFiltersV2,
}}
commands={[
{
name: "ai-assistant",
icon: <AiAssistantCommandIcon />,
component: (
<AiAssistantProvider
apiUrl={process.env.NEXT_PUBLIC_AI_ASSISTANT_URL || "temp"}
websiteId={process.env.NEXT_PUBLIC_AI_WEBSITE_ID || "temp"}
recaptchaSiteKey={
process.env.NEXT_PUBLIC_AI_API_ASSISTANT_RECAPTCHA_SITE_KEY ||
"temp"
}
/>
),
title: "AI Assistant",
badge: {
variant: "purple",
children: "Beta",
},
},
]}
>
{children}
</UiSearchProvider>
@@ -1,47 +0,0 @@
"use client"
import { createContext, useContext, useMemo } from "react"
import { Version } from "../types/openapi"
import { usePathname } from "next/navigation"
type VersionContextType = {
version: Version
isVersioningEnabled: boolean
}
const VersionContext = createContext<VersionContextType | null>(null)
type VersionProviderProps = {
children: React.ReactNode
}
const VersionProvider = ({ children }: VersionProviderProps) => {
const pathname = usePathname()
const version = useMemo(() => {
return pathname.includes("v2") ? "2" : "1"
}, [pathname])
return (
<VersionContext.Provider
value={{
version,
isVersioningEnabled: process.env.NEXT_PUBLIC_VERSIONING === "true",
}}
>
{children}
</VersionContext.Provider>
)
}
export default VersionProvider
export const useVersion = (): VersionContextType => {
const context = useContext(VersionContext)
if (!context) {
throw new Error("useVersion must be used inside an VersionProvider")
}
return context
}