asyavee/medusa-store
1
0
Fork 0
Code Issues Pull Requests Actions 2 Packages Projects Releases Wiki Activity

docs: modified README files (#4782)

Browse Source
This commit is contained in:
Shahed Nasser
2023-08-16 17:12:42 +03:00
committed by GitHub
parent 9165f3214b
commit 8336e2002a
3 changed files with 17 additions and 41 deletions
Download Patch File Download Diff File Expand all files Collapse all files

11
www/README.md Normal file
View File

@@ -0,0 +1,11 @@
# Documentation Resources
This directory holds the code and content of both the [documentation](https://docs.medusajs.com/) and [API reference](https://docs.medusajs.com/api/admin).
## docs Directory
The `docs` directory holds the code and content of the documentation website. The website is built with [Docusaurus v2](https://docusaurus.io/).
### api-reference Directory
The `api-reference` directory holds the code and OpenApi Specs of the API Reference. The API Reference is built with [Next.js](https://nextjs.org/).

35
www/api-reference/README.md
View File

@@ -1,34 +1,7 @@
This is a [Next.js](https://nextjs.org/) project bootstrapped with [`create-next-app`](https://github.com/vercel/next.js/tree/canary/packages/create-next-app).
# Medusa API Reference
## Getting Started
The Medusa API Reference website is built with Next.js 13. You can learn more about contributing [here](https://docs.medusajs.com/contribution-guidelines).
First, run the development server:
## Note About OpenAPI Specs
```bash
npm run dev
# or
yarn dev
# or
pnpm dev
```
Open [http://localhost:3000](http://localhost:3000) with your browser to see the result.
You can start editing the page by modifying `app/page.tsx`. The page auto-updates as you edit the file.
This project uses [`next/font`](https://nextjs.org/docs/basic-features/font-optimization) to automatically optimize and load Inter, a custom Google Font.
## Learn More
To learn more about Next.js, take a look at the following resources:
- [Next.js Documentation](https://nextjs.org/docs) - learn about Next.js features and API.
- [Learn Next.js](https://nextjs.org/learn) - an interactive Next.js tutorial.
You can check out [the Next.js GitHub repository](https://github.com/vercel/next.js/) - your feedback and contributions are welcome!
## Deploy on Vercel
The easiest way to deploy your Next.js app is to use the [Vercel Platform](https://vercel.com/new?utm_medium=default-template&filter=next.js&utm_source=create-next-app&utm_campaign=create-next-app-readme) from the creators of Next.js.
Check out our [Next.js deployment documentation](https://nextjs.org/docs/deployment) for more details.
The OpenAPI Specs under the directory `specs` are automatically generated by our OAS CLI tool. So, contributions should be made in the files under `packages/medusa/src/api` instead of directly making changes to the generated spec files.

12
www/docs/README.md
View File

@@ -1,14 +1,6 @@
# Website
# Medusa Documentation
This website is built using [Docusaurus 2](https://docusaurus.io/), a modern static website generator.
## Note Before Development
If you have installed the dependencies in the root of this repository (in other words, if you have a `node_modules` directory at the root of this repository), this will cause an error when running this documentation website. This is because the content resides in `docs/content` and when that content is being imported from there, a mix up can happen between the dependencies which will cause an `invalid hook call` error.
For that reason, the `clean-node-modules` script was added that deletes the `node_modules` directory. The script is called that script before the `start` and `build` scripts are ran.
So, everytime you run these two scripts, the `node_modules` directory at the root will be deleted.
The Medusa documentation website is built with Docusaurus v2. You can learn more about contributing [here](https://docs.medusajs.com/contribution-guidelines).
## Components and Theme