docs: general fixes and improvements (#7918)

* docs improvements and changes

* updated module definition

* modules + dml changes

* fix build

* fix vale error

* fix lint errors

* fixes to stripe docs

* fix condition

* fix condition

* fix module defintion

* fix checkout

* disable UI action

* change oas preview action

* flatten provider module options

* fix lint errors

* add module link docs

* pr comments fixes

* fix vale error

* change node engine version

* links -> linkable

* add note about database name

* small fixes

* link fixes

* fix response code in api reference

* added migrations step
This commit is contained in:
Shahed Nasser
2024-07-04 17:26:03 +03:00
committed by GitHub
parent 32982e708a
commit 964927b597
149 changed files with 1676 additions and 3008 deletions
@@ -0,0 +1,23 @@
export const metadata = {
title: `${pageNumber} Project Directories and Files`,
}
# {metadata.title}
In this chapter, youll learn about important directories and files in your Medusa application's project.
## src
This directory is the central place for your custom development. It includes the following sub-directories:
- `admin`: Holds your admin dashboard's custom components and pages.
- `api`: Holds your custom API routes that are added as endpoints in your Medusa application.
- `jobs`: Holds your scheduled jobs that run at a specified interval during your Medusa application's runtime.
- `modules`: Holds your custom modules that implement custom business logic.
- `scripts`: Holds your custom scripts to be executed using Medusa's CLI tool.
- `subscribers`: Holds your event listeners that are executed asynchronously whenever an event is emitted.
- `workflows`: Holds your custom flows that can be executed from anywhere in your application.
## medusa-config.js
This file holds your Medusa configurations, such as your PostgreSQL database configurations.