Files
medusa-store/www/apps/docs/content/homepage.mdx
Shahed Nasser bb87db8342 docs: prep for v2 documentation (#6710)
This PR includes documentation that preps for v2 docs (but doesn't introduce new docs).

_Note: The number of file changes in the PR is due to find-and-replace within the `references` which is unavoidable. Let me know if I should move it to another PR._

## Changes

- Change Medusa version in base OAS used for v2.
- Fix to docblock generator related to not catching all path parameters.
- Added typedoc plugin that generates ER Diagrams, which will be used specifically for data model references in commerce modules.
- Changed OAS tool to output references in `www/apps/api-reference/specs-v2` directory when the `--v2` option is used.
- Added a version switcher to the API reference to switch between V1 and V2. This switcher is enabled by an environment variable, so it won't be visible/usable at the moment.
- Upgraded docusaurus to v3.0.1
- Added new Vale rules to ensure correct spelling of Medusa Admin and module names.
- Added new components to the `docs-ui` package that will be used in future documentation changes.
2024-03-18 07:47:35 +00:00

199 lines
5.4 KiB
Plaintext
Raw Blame History

This file contains ambiguous Unicode characters
This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.
---
id: homepage
title: Medusa Documentation
description: "Medusa is an open source composable commerce platform. Learn about its features and how to use it."
slug: /
hide_table_of_contents: true
hide_footer: true
---
import DocCardList from '@theme/DocCardList';
import DocCard from '@theme/DocCard';
import Icons from '@theme/Icon';
# Medusa Documentation
Medusa is a set of commerce tools and modules that can be used to build unique commerce experiences.
Medusa provides the essential building blocks that developers can put together to create a powerful commerce store. Developers have full control over their tech stack and the logic behind the commerce features.
<DocCard item={{
type: 'link',
href: '/create-medusa-app',
label: 'Get Started',
customProps: {
icon: Icons['bolt-solid'],
html: 'Create a full-fledged Medusa project with one command.',
className: 'card-highlighted'
}
}} />
## Explore Medusa
<DocCardList colSize={4} items={[
{
type: 'link',
href: '/modules/overview',
label: 'Commerce Modules',
customProps: {
icon: Icons['puzzle-solid'],
description: 'Learn about the available ecommerce features and how to use and customize them.'
}
},
{
type: 'link',
href: '/development/overview',
label: 'Medusa Development',
customProps: {
icon: Icons['server-stack-solid'],
description: 'Learn how to develop customized digital commerce applications with Medusa.'
}
},
{
type: 'link',
href: '/user-guide',
label: 'User Guide',
customProps: {
icon: Icons['users-solid'],
description: 'No-code guides to help users manage their ecommerce stores using the Medusa Admin.'
}
}
]} />
## Medusa Toolkit
<DocCardList colSize={6} items={[
{
type: 'link',
href: '/development/backend/install',
label: 'Medusa Backend',
customProps: {
icon: Icons['circle-stack-solid'],
html: 'A Medusa Backend is any Node.js project with @medusajs/medusa installed. The core Medusa package orchestrates Medusa\'s Commerce Modules to expose powerful and customizable REST APIs.',
}
},
{
type: 'link',
href: '/admin/quickstart',
label: 'Admin Dashboard',
customProps: {
icon: Icons['computer-desktop-solid'],
description: 'An admin dashboard used along with the Medusa backend and commerce modules. Merchants can use it to manage orders, products, customers, and much more.'
}
},
]} />
<DocCardList colSize={4} items={[
{
type: 'link',
href: '/js-client/overview',
label: 'JavaScript Client',
customProps: {
icon: Icons['javascript'],
description: 'Interact with a Medusa backend from a storefront or an admin built with any JavaScript framework.'
}
},
{
type: 'link',
href: '/medusa-react/overview',
label: 'Medusa React',
customProps: {
icon: Icons['react'],
description: 'Interact with a Medusa backend from a React storefront or admin with utilities, hooks, and contexts.'
}
},
{
type: 'link',
href: '/plugins/overview',
label: 'Plugins',
customProps: {
icon: Icons['squares-plus-solid'],
description: 'Supercharge your Medusa backend with plugins for Storage, Notifications, Analytics, and more.'
}
},
]} />
<DocCardList colSize={6} items={[
{
type: 'link',
href: '/cli/reference',
label: 'Medusa CLI',
customProps: {
icon: Icons['command-line-solid'],
description: 'Use the Medusa CLI tool to execute commands on your Medusa backend.'
}
},
{
type: 'link',
href: '/starters/nextjs-medusa-starter',
label: 'Next.js Starter Template',
customProps: {
icon: Icons['nextjs'],
description: 'Install the Next.js starter template and use it as the storefront for the Medusa backend.'
}
},
]} />
<DocCardList colSize={6} items={[
{
type: 'link',
href: 'https://docs.medusajs.com/api/admin',
label: 'Admin API Reference',
customProps: {
icon: Icons['circle-stack-solid'],
description: 'Check out available REST APIs with example code snippets.'
}
},
{
type: 'link',
href: 'https://docs.medusajs.com/api/store',
label: 'Store API Reference',
customProps: {
icon: Icons['computer-desktop-solid'],
description: 'Check out available REST APIs with example code snippets.'
}
},
]} />
## What's New
Learn about all the new features and enhancements in Medusa.
<DocCardList colSize={4} items={[
{
type: 'link',
href: '/medusa-react/overview',
label: 'Medusa React reference',
customProps: {
icon: Icons['react'],
description: 'Explore all hooks, providers, and utilities of Medusa React.',
}
},
{
type: 'link',
href: '/development/events/create-subscriber',
label: 'Subscribers',
customProps: {
icon: Icons['cog-six-tooth-solid'],
description: 'Create subscribers with an improved developer experienece.',
}
},
{
type: 'link',
href: '/development/api-routes/create',
label: 'API Routes',
customProps: {
icon: Icons['server-stack-solid'],
description: 'Create API Routes with an improved developer experience.',
}
},
]} />
<!-- vale docs.HeadingPunctuation = NO -->
## Need Help?
<!-- vale docs.HeadingPunctuation = YES -->
If youre still not sure that Medusa is the right solution for you, you can get in-touch with the core Medusa team over at [Discord](https://discord.gg/medusajs) and get help from the community.