remove main reference page
This commit is contained in:
Shahed Nasser
@@ -27,8 +27,8 @@ If you think this is a mistake, please [report this issue on GitHub](https://git
|
||||
icon: BookOpen
|
||||
},
|
||||
{
|
||||
title: "Development Resources",
|
||||
href: "!resources!",
|
||||
title: "Commerce Modules",
|
||||
href: "!resources!/commerce-modules",
|
||||
icon: AcademicCapSolid
|
||||
},
|
||||
{
|
||||
|
||||
@@ -8,9 +8,9 @@ The previous guides introduced Medusa's different concepts and how you can use t
|
||||
|
||||
The next chapters will cover each of these concepts in depth, with the different ways you can use them, their options or configurations, and more advanced features that weren't covered in the previous guides. While you can start building with Medusa, it's highly recommended to follow the next chapters for a better understanding of Medusa's fundamentals.
|
||||
|
||||
## Helpful Resources Guides
|
||||
## Useful Guides
|
||||
|
||||
The [Development Resources](!resources!) documentation provides more helpful guides and references for your development journey. Some of these guides and references include:
|
||||
The following guides and references are useful for your development journey:
|
||||
|
||||
3. [Commerce Modules](!resources!/commerce-modules): Browse the list of commerce modules in Medusa and their references to learn how to use them.
|
||||
1. [Service Factory Reference](!resources!/service-factory-reference): Learn about the methods generated by `MedusaService` with examples.
|
||||
@@ -21,6 +21,4 @@ The [Development Resources](!resources!) documentation provides more helpful gui
|
||||
|
||||
## More Examples in Recipes
|
||||
|
||||
In the Development Resources documentation, you'll also find step-by-step guides for different use cases, such as building a marketplace, digital products, and more.
|
||||
|
||||
Refer to the [Recipes](!resources!/recipes) documentation to learn more.
|
||||
In the [Recipes](!resources!/recipes) documentation, you'll also find step-by-step guides for different use cases, such as building a marketplace, digital products, and more.
|
||||
|
||||
+2
-2
@@ -83,7 +83,7 @@ This runs your Medusa application and runs the tests available under the `src/in
|
||||
|
||||
## Other Options and Inputs
|
||||
|
||||
Refer to [this reference in the Development Resources documentation](!resources!/test-tools-reference/medusaIntegrationTestRunner) for other available parameter options and inputs of the `testSuite` function.
|
||||
Refer to [the Test Tooling Reference](!resources!/test-tools-reference/medusaIntegrationTestRunner) for other available parameter options and inputs of the `testSuite` function.
|
||||
|
||||
---
|
||||
|
||||
@@ -91,7 +91,7 @@ Refer to [this reference in the Development Resources documentation](!resources!
|
||||
|
||||
The `medusaIntegrationTestRunner` function creates a database with a random name before running the tests. Then, it drops that database after all the tests end.
|
||||
|
||||
To manage that database, such as changing its name or perform operations on it in your tests, refer to the [references in the Development Resources documentation](!resources!/test-tools-reference/medusaIntegrationTestRunner).
|
||||
To manage that database, such as changing its name or perform operations on it in your tests, refer to [the Test Tooling Reference](!resources!/test-tools-reference/medusaIntegrationTestRunner).
|
||||
|
||||
---
|
||||
|
||||
|
||||
@@ -125,7 +125,7 @@ jest.setTimeout(60 * 1000)
|
||||
|
||||
### Other Options and Inputs
|
||||
|
||||
Refer to [this reference in the Development Resources documentation](!resources!/test-tools-reference/moduleIntegrationTestRunner) for other available parameter options and inputs of the `testSuite` function.
|
||||
Refer to [the Test Tooling Reference](!resources!/test-tools-reference/moduleIntegrationTestRunner) for other available parameter options and inputs of the `testSuite` function.
|
||||
|
||||
---
|
||||
|
||||
@@ -133,4 +133,4 @@ Refer to [this reference in the Development Resources documentation](!resources!
|
||||
|
||||
The `moduleIntegrationTestRunner` function creates a database with a random name before running the tests. Then, it drops that database after all the tests end.
|
||||
|
||||
To manage that database, such as changing its name or perform operations on it in your tests, refer to the [references in the Development Resources documentation](!resources!/test-tools-reference/moduleIntegrationTestRunner).
|
||||
To manage that database, such as changing its name or perform operations on it in your tests, refer to [the Test Tooling Reference](!resources!/test-tools-reference/moduleIntegrationTestRunner).
|
||||
|
||||
@@ -12,7 +12,7 @@ So, resources in the module, such as services or loaders, can only resolve other
|
||||
|
||||
### List of Registered Resources
|
||||
|
||||
Find a list of resources or dependencies registered in a module's container in [this Development Resources reference](!resources!/medusa-container-resources).
|
||||
Find a list of resources or dependencies registered in a module's container in [the Container Resources reference](!resources!/medusa-container-resources).
|
||||
|
||||
---
|
||||
|
||||
|
||||
@@ -79,9 +79,11 @@ By following this documentation, you'll be able to create custom commerce experi
|
||||
This documentation is split into the following sections:
|
||||
|
||||
1. The main documentation, which is the one you're currently reading. It's recommended to follow the chapters in this documentation to understand the core concepts of Medusa and how to use them.
|
||||
2. The [Development Resources documentation](!resources!) provides guides and resources useful during your development, such as tools, API references, recipes, step-by-step guides and examples, and more.
|
||||
3. The [Store](!api!/store) and [Admin](!api!/admin) API references provide a reference to the Medusa application's endpoints and instructions related to authentication, parameter types in requests, and more.
|
||||
4. The [User Guide](!user-guide!) introduces you to the Medusa Admin dashboard and helps merchants and store managers understand how to use the dashboard to manage their store.
|
||||
2. The Product section, which holds the [Commerce](!resources!/commerce-modules) and [Architectural](!resources!/architectural-modules). You can browse those to learn more about Medusa's commerce features and architecture, and find guides specific to each of these modules.
|
||||
3. The Build section, which holds [recipes](!resources!/recipes), [how-to guides and tutorials](!resources!/how-to-tutorials), [integrations](!resources!/integrations), and [storefront development](!resources!/storefront-development) guides.
|
||||
4. The [Store](!api!/store) and [Admin](!api!/admin) API references provide a reference to the Medusa application's endpoints and instructions related to authentication, parameter types in requests, and more.
|
||||
5. The [References section](!resources!/references-overview) that's useful during your development with Medusa to learn about different APIs and how to use them. Its references include the [events reference](!resources!/events-reference), [core workflows reference](!resources!/medusa-workflows-reference), and more.
|
||||
6. The [User Guide](!user-guide!) introduces you to the Medusa Admin dashboard and helps merchants and store managers understand how to use the dashboard to manage their store.
|
||||
|
||||
To get started, check out the [Installation chapter](./installation/page.mdx).
|
||||
|
||||
|
||||
@@ -20,7 +20,7 @@ The workspace has the following two directories:
|
||||
|
||||
- `apps`: this directory holds the different documentation websites and projects.
|
||||
- `book`: includes the codebase for the [main Medusa documentation](https://docs.medusajs.com/). It's built with [Next.js 15](https://nextjs.org/).
|
||||
- `resources`: includes the codebase for the Medusa Development Resources documentation. It's built with [Next.js 15](https://nextjs.org/).
|
||||
- `resources`: includes the codebase for the resources documentation, which powers different sections of the docs such as the [Integrations](!resources!/integrations) or [How-to & Tutorials](!resources!/how-to-tutorials) sections. It's built with [Next.js 15](https://nextjs.org/).
|
||||
- `api-reference`: includes the codebase for the API reference website. It's built with [Next.js 15](https://nextjs.org/).
|
||||
- `ui`: includes the codebase for the Medusa UI documentation website. It's built with [Next.js 15](https://nextjs.org/).
|
||||
- `packages`: this directory holds the shared packages and components necessary for the development of the projects in the `apps` directory.
|
||||
@@ -37,9 +37,9 @@ All documentation projects are built with Next.js. The content is writtin in MDX
|
||||
|
||||
The content of the Medusa main docs are under the `www/apps/book/app` directory.
|
||||
|
||||
### Medusa Development Resources Content
|
||||
### Medusa Resources Content
|
||||
|
||||
The content of the Medusa Resources documentation are under the `www/apps/resources/app` directory.
|
||||
The content of all pages under the `/resources` path are under the `www/apps/resources/app` directory.
|
||||
|
||||
<Note>
|
||||
|
||||
|
||||
@@ -6,7 +6,7 @@ const baseUrl = process.env.NEXT_PUBLIC_BASE_URL || "http://localhost:3000"
|
||||
|
||||
export const config: DocsConfig = {
|
||||
...globalConfig,
|
||||
titleSuffix: "Medusa v2 Documentation",
|
||||
titleSuffix: "Medusa Documentation",
|
||||
baseUrl,
|
||||
basePath: process.env.NEXT_PUBLIC_BASE_PATH,
|
||||
sidebars: generatedSidebars as Sidebar.Sidebar[],
|
||||
|
||||
@@ -928,5 +928,3 @@ You've now implemented custom item pricing in Medusa. You can also customize the
|
||||
If you're new to Medusa, check out the [main documentation](!docs!/learn), where you'll get a more in-depth learning of all the concepts you've used in this guide and more.
|
||||
|
||||
To learn more about the commerce features that Medusa provides, check out Medusa's [Commerce Modules](../../../commerce-modules/page.mdx).
|
||||
|
||||
For other general guides related to [deployment](../../../deployment/page.mdx), [storefront development](../../../storefront-development/page.mdx), [integrations](../../../integrations/page.mdx), and more, check out the [Development Resources](../../../page.mdx).
|
||||
|
||||
@@ -871,5 +871,3 @@ You've now integrated Medusa with Resend. You can add more templates for other e
|
||||
If you're new to Medusa, check out the [main documentation](!docs!/learn), where you'll get a more in-depth learning of all the concepts you've used in this guide and more.
|
||||
|
||||
To learn more about the commerce features that Medusa provides, check out Medusa's [Commerce Modules](../../../commerce-modules/page.mdx).
|
||||
|
||||
For other general guides related to deployment, storefront development, integrations, and more, check out the [Development Resources](../../../page.mdx).
|
||||
|
||||
@@ -1950,5 +1950,3 @@ You've now integrated Medusa with Sanity and can benefit from powerful commerce
|
||||
If you're new to Medusa, check out the [main documentation](!docs!/learn), where you'll get a more in-depth learning of all the concepts you've used in this guide and more.
|
||||
|
||||
To learn more about the commerce features that Medusa provides, check out Medusa's [Commerce Modules](../../../commerce-modules/page.mdx).
|
||||
|
||||
For other general guides related to deployment, storefront development, integrations, and more, check out the [Development Resources](../../../page.mdx).
|
||||
|
||||
@@ -1410,5 +1410,3 @@ You've now integrated Medusa with ShipStation. You can fulfill orders with many
|
||||
If you're new to Medusa, check out the [main documentation](!docs!/learn), where you'll get a more in-depth learning of all the concepts you've used in this guide and more.
|
||||
|
||||
To learn more about the commerce features that Medusa provides, check out Medusa's [Commerce Modules](../../../commerce-modules/page.mdx).
|
||||
|
||||
For other general guides related to deployment, storefront development, integrations, and more, check out the [Development Resources](../../../page.mdx).
|
||||
|
||||
@@ -25,8 +25,8 @@ If you think this is a mistake, please [report this issue on GitHub](https://git
|
||||
icon: BookOpen
|
||||
},
|
||||
{
|
||||
title: "Development Resources",
|
||||
href: "!resources!",
|
||||
title: "Commerce Modules",
|
||||
href: "!resources!/commerce-modules",
|
||||
icon: AcademicCapSolid
|
||||
},
|
||||
{
|
||||
|
||||
@@ -1,154 +0,0 @@
|
||||
import {
|
||||
TagSolid,
|
||||
CheckCircleSolid,
|
||||
ShoppingCartSolid,
|
||||
CurrencyDollarSolid,
|
||||
UsersSolid,
|
||||
PuzzleSolid,
|
||||
EnvelopeSolid,
|
||||
ArrowDownTray,
|
||||
ChartBar,
|
||||
Text,
|
||||
SquaresPlusSolid,
|
||||
JavascriptEx,
|
||||
ReactJsEx,
|
||||
CommandLineSolid,
|
||||
NextJs,
|
||||
BuildingStorefront,
|
||||
CreditCardSolid,
|
||||
ClockSolid,
|
||||
DocumentTextSolid,
|
||||
Stripe,
|
||||
PhotoSolid,
|
||||
BuildingsSolid,
|
||||
CircleStackSolid,
|
||||
} from "@medusajs/icons"
|
||||
|
||||
# Medusa Development Resources
|
||||
|
||||
Explore Medusa's commerce modules, SDKs, configurations, recipes, and more.
|
||||
|
||||
<Note title="Don't code?">
|
||||
|
||||
Check out the [Meduse Admin User Guide](!user-guide!) to learn how to manage your store.
|
||||
|
||||
</Note>
|
||||
|
||||
<Note title="Getting started?">
|
||||
|
||||
Follow the [Medusa Docs](!docs!/learn) to become an advanced Medusa developer.
|
||||
|
||||
</Note>
|
||||
|
||||
## Commerce Modules
|
||||
|
||||
<CardList items={[
|
||||
{
|
||||
icon: TagSolid,
|
||||
title: "Product Module",
|
||||
href: "/commerce-modules/product",
|
||||
},
|
||||
{
|
||||
icon: CheckCircleSolid,
|
||||
title: "Order Module",
|
||||
href: "/commerce-modules/order",
|
||||
},
|
||||
{
|
||||
icon: ShoppingCartSolid,
|
||||
title: "Cart Module",
|
||||
href: "/commerce-modules/cart",
|
||||
},
|
||||
{
|
||||
icon: CurrencyDollarSolid,
|
||||
title: "Pricing Module",
|
||||
href: "/commerce-modules/pricing",
|
||||
},
|
||||
{
|
||||
icon: UsersSolid,
|
||||
title: "Customer Module",
|
||||
href: "/commerce-modules/customer",
|
||||
},
|
||||
{
|
||||
type: "filler",
|
||||
text: "Find more modules for your commerce application.",
|
||||
href: "/commerce-modules"
|
||||
}
|
||||
]} />
|
||||
|
||||
---
|
||||
|
||||
## Integrations
|
||||
|
||||
<CardList items={[
|
||||
{
|
||||
icon: Stripe,
|
||||
title: "Stripe",
|
||||
iconClassName: "[&_path]:fill-medusa-fg-subtle",
|
||||
href: "/commerce-modules/payment/payment-provider/stripe",
|
||||
},
|
||||
{
|
||||
icon: EnvelopeSolid,
|
||||
title: "SendGrid",
|
||||
href: "/architectural-modules/notification/sendgrid",
|
||||
},
|
||||
{
|
||||
icon: DocumentTextSolid,
|
||||
title: "S3",
|
||||
href: "/architectural-modules/file/s3",
|
||||
},
|
||||
{
|
||||
type: "filler",
|
||||
text: "Integrate other third-party services to your application.",
|
||||
href: "/integrations"
|
||||
}
|
||||
]} />
|
||||
|
||||
---
|
||||
|
||||
## Recipes
|
||||
|
||||
<CardList items={[
|
||||
{
|
||||
icon: BuildingStorefront,
|
||||
title: "Marketplace",
|
||||
href: "/recipes/marketplace",
|
||||
},
|
||||
{
|
||||
icon: CreditCardSolid,
|
||||
title: "Subscriptions",
|
||||
href: "/recipes/subscriptions",
|
||||
},
|
||||
{
|
||||
icon: PhotoSolid,
|
||||
title: "Digital Products",
|
||||
href: "/recipes/digital-products",
|
||||
},
|
||||
{
|
||||
icon: CircleStackSolid,
|
||||
title: "Integrate ERP",
|
||||
href: "/recipes/erp",
|
||||
},
|
||||
]} />
|
||||
|
||||
---
|
||||
|
||||
## SDKs and Tools
|
||||
|
||||
<CardList itemsPerRow={3} items={[
|
||||
{
|
||||
icon: JavascriptEx,
|
||||
title: "JS SDK",
|
||||
href: "/js-sdk",
|
||||
},
|
||||
{
|
||||
icon: CommandLineSolid,
|
||||
title: "Medusa CLI",
|
||||
href: "/medusa-cli",
|
||||
},
|
||||
{
|
||||
icon: NextJs,
|
||||
iconClassName: "[&_path]:fill-medusa-fg-subtle",
|
||||
title: "Next.js Starter",
|
||||
href: "/nextjs-starter",
|
||||
},
|
||||
]} />
|
||||
@@ -2173,5 +2173,3 @@ You've now implemented the wishlist functionality in a Medusa plugin. You can pu
|
||||
If you're new to Medusa, check out the [main documentation](!docs!/learn), where you'll get a more in-depth learning of all the concepts you've used in this guide and more.
|
||||
|
||||
To learn more about the commerce features that Medusa provides, check out Medusa's [Commerce Modules](../../../commerce-modules/page.mdx).
|
||||
|
||||
For other general guides related to [deployment](../../../deployment/page.mdx), [storefront development](../../../storefront-development/page.mdx), [integrations](../../../integrations/page.mdx), and more, check out the [Development Resources](../../../page.mdx).
|
||||
|
||||
@@ -1490,5 +1490,3 @@ You've now implemented restock notifications in Medusa. You can also customize t
|
||||
If you're new to Medusa, check out the [main documentation](!docs!/learn), where you'll get a more in-depth learning of all the concepts you've used in this guide and more.
|
||||
|
||||
To learn more about the commerce features that Medusa provides, check out Medusa's [Commerce Modules](../../../commerce-modules/page.mdx).
|
||||
|
||||
For other general guides related to [deployment](../../../deployment/page.mdx), [storefront development](../../../storefront-development/page.mdx), [integrations](../../../integrations/page.mdx), and more, check out the [Development Resources](../../../page.mdx).
|
||||
|
||||
@@ -893,5 +893,3 @@ You now have the foundation for integrating Odoo with Medusa. You can expand on
|
||||
If you're new to Medusa, check out the [main documentation](!docs!/learn), where you'll get a more in-depth learning of all the concepts you've used in this guide and more.
|
||||
|
||||
To learn more about the commerce features that Medusa provides, check out Medusa's [Commerce Modules](../../../commerce-modules/page.mdx).
|
||||
|
||||
For other general guides related to [deployment](../../../deployment/page.mdx), [storefront development](../../../storefront-development/page.mdx), [integrations](../../../integrations/page.mdx), and more, check out the [Development Resources](../../../page.mdx).
|
||||
|
||||
@@ -2734,5 +2734,3 @@ You can add more features to your storefront or commerce application. For exampl
|
||||
If you're new to Medusa, check out the [main documentation](!docs!/learn), where you'll get a more in-depth learning of all the concepts you've used in this guide and more.
|
||||
|
||||
To learn more about the commerce features that Medusa provides, check out Medusa's [Commerce Modules](../../../commerce-modules/page.mdx).
|
||||
|
||||
For other general guides related to deployment, storefront development, integrations, and more, check out the [Development Resources](../../../page.mdx).
|
||||
|
||||
@@ -5,7 +5,7 @@ const baseUrl = process.env.NEXT_PUBLIC_BASE_URL || "http://localhost:3000"
|
||||
|
||||
export const config: DocsConfig = {
|
||||
...globalConfig,
|
||||
titleSuffix: "Medusa Development Resources",
|
||||
titleSuffix: "Medusa Documentation",
|
||||
baseUrl,
|
||||
basePath: process.env.NEXT_PUBLIC_BASE_PATH,
|
||||
sidebars: [],
|
||||
|
||||
@@ -143,6 +143,16 @@ const nextConfig = {
|
||||
destination: `${process.env.NEXT_PUBLIC_BASE_URL}/learn/resources/usage`,
|
||||
permanent: true,
|
||||
},
|
||||
{
|
||||
source: "/plugins",
|
||||
destination: "/integrations",
|
||||
permanent: true,
|
||||
},
|
||||
{
|
||||
source: "/resources",
|
||||
destination: "/recipes",
|
||||
permanent: true,
|
||||
},
|
||||
]
|
||||
},
|
||||
outputFileTracingExcludes: {
|
||||
|
||||
@@ -25,8 +25,8 @@ If you think this is a mistake, please [report this issue on GitHub](https://git
|
||||
icon: BookOpen
|
||||
},
|
||||
{
|
||||
title: "Development Resources",
|
||||
href: "!resources!",
|
||||
title: "Commerce Modules",
|
||||
href: "!resources!/commerce-modules",
|
||||
icon: AcademicCapSolid
|
||||
},
|
||||
{
|
||||
|
||||
@@ -39,8 +39,8 @@ export default function NotFound() {
|
||||
icon: BookOpen,
|
||||
},
|
||||
{
|
||||
title: "Development Resources",
|
||||
href: "!resources!",
|
||||
title: "Commerce Modules",
|
||||
href: "!resources!/commerce-modules",
|
||||
icon: AcademicCapSolid,
|
||||
},
|
||||
{
|
||||
|
||||
@@ -25,8 +25,8 @@ If you think this is a mistake, please [report this issue on GitHub](https://git
|
||||
icon: BookOpen
|
||||
},
|
||||
{
|
||||
title: "Development Resources",
|
||||
href: "!resources!",
|
||||
title: "Commerce Modules",
|
||||
href: "!resources!/commerce-modules",
|
||||
icon: AcademicCapSolid
|
||||
},
|
||||
{
|
||||
|
||||
Reference in New Issue
Block a user