docs: change configurations to make v2 the main docs (#9729)

* docs: change configurations to make v2 the main docs

* move api routes to top level

* remove api prefix

* update opengraph images

* show v1 link

* add redirect to v1
This commit is contained in:
Shahed Nasser
2024-10-24 14:49:58 +03:00
committed by GitHub
parent 471f7e4a10
commit 88f2d17a24
40 changed files with 115 additions and 128 deletions
+1 -1
View File
@@ -838,7 +838,7 @@ If you click on the workflow, you'll view a reference of that workflow, includin
This is useful if you want to extend an API route and pass additional data or perform custom actions.
Refer to [this guide](https://docs.medusajs.com/v2/customization/extend-models/extend-create-product) to find an example of extending an API route.
Refer to [this guide](https://docs.medusajs.com/customization/extend-models/extend-create-product) to find an example of extending an API route.
<Feedback
event="survey_api-ref"
@@ -4,7 +4,7 @@ import DownloadFull from "@/components/DownloadFull"
<H3 className="!mt-0">Just Getting Started?</H3>
Check out the [Medusa v2 Documentation](https://docs.medusajs.com/v2).
Check out the [Medusa v2 Documentation](https://docs.medusajs.com).
<Space bottom={8} />
@@ -16,7 +16,7 @@ To use Medusa's JS SDK library, install the following packages in your project (
npm install @medusajs/js-sdk@latest @medusajs/types@latest
```
Learn more about the JS SDK in [this documentation](https://docs.medusajs.com/v2/resources/js-sdk).
Learn more about the JS SDK in [this documentation](https://docs.medusajs.com/resources/js-sdk).
### Download Full Reference
+2 -2
View File
@@ -270,7 +270,7 @@ and associate placed orders with the specified sales channel.
{/* TODO add v2 links */}
Create a publishable API key either using the [admin REST APIs](https://docs.medusajs.com/v2/api/admin#api-keys_postapikeys), or using the Medusa Admin.
Create a publishable API key either using the [admin REST APIs](https://docs.medusajs.com/api/admin#api-keys_postapikeys), or using the Medusa Admin.
### How to Use a Publishable API Key
@@ -839,7 +839,7 @@ If you click on the workflow, you'll view a reference of that workflow, includin
This is useful if you want to extend an API route and pass additional data or perform custom actions.
Refer to [this guide](https://docs.medusajs.com/v2/customization/extend-models/extend-create-product) to find an example of extending an API route.
Refer to [this guide](https://docs.medusajs.com/customization/extend-models/extend-create-product) to find an example of extending an API route.
<Feedback
event="survey_api-ref"
@@ -1,11 +1,11 @@
import OpenAPIParser from "@readme/openapi-parser"
import algoliasearch from "algoliasearch"
import type { ExpandedDocument, Operation } from "../../../types/openapi"
import type { ExpandedDocument, Operation } from "../../types/openapi"
import path from "path"
import getSectionId from "../../../utils/get-section-id"
import getSectionId from "../../utils/get-section-id"
import { NextResponse } from "next/server"
import { JSDOM } from "jsdom"
import getUrl from "../../../utils/get-url"
import getUrl from "../../utils/get-url"
import { capitalize } from "docs-ui"
export async function GET() {
Binary file not shown.

Before

Width:  |  Height:  |  Size: 253 KiB

After

Width:  |  Height:  |  Size: 161 KiB

@@ -1,7 +1,7 @@
import { NextResponse } from "next/server"
import path from "path"
import { existsSync } from "fs"
import getSchemaContent from "../../../utils/get-schema-content"
import getSchemaContent from "../../utils/get-schema-content"
export async function GET(request: Request) {
const { searchParams } = new URL(request.url)
Binary file not shown.

Before

Width:  |  Height:  |  Size: 253 KiB

After

Width:  |  Height:  |  Size: 161 KiB