Thank you for your interest in contributing to the documentation! You will be helping the open source community and other developers interested in learning more about Medusa and using it.
This guide is specific to contributing to the documentation. If you’re interested in contributing to Medusa’s codebase, check out the contributing guidelines in the Medusa GitHub repository.
The documentation website is built with Docusaurus, a framework that optimizes documentation creation. If you’re not familiar with Docusaurus, it’s recommended to check out the Installation documentation on their website to better understand Docusaurus, how it works, its structure, and more details.
The documentation content is written in Markdown format and is located in the docs/content directory of the same repository. If you’re not familiar with Markdown, check out this cheat sheet for a quick start.
You’ll also find MDX files. MDX files combine the power of Markdown with React. So, the content of the file can contain JSX components and import statements, among other features. You can learn more about MDX in docusaurus’s guide.
What You Can Contribute To
- You can contribute to the Docusaurus codebase to add a new feature or fix a bug in the documentation website.
- You can contribute to the documentation content either by fixing errors you find or adding documentation pages.
What You Can’t Contribute To
The Services Reference is an automatically generated API reference using Typedoc. So, you can’t contribute to it by making changes to its markdown files.
You can, however, contribute to the script generating it if you find any issues in it.
When you contribute to the documentation content, make sure to follow the documentation style guide.
How to Contribute
If you’re fixing errors in an existing documentation page, you can scroll down to the end of the page and click on the “Edit this page” link. You’ll be redirected to the GitHub edit form of that page and you can make edits directly and submit a pull request (PR).
If you’re adding a new page or contributing to the codebase, fork the repository, create a new branch, and make all changes necessary in your repository. Then, once you’re done creating a PR in the Medusa repository.
For more details on how to contribute, check out the contribution guidelines on our repository.
When you make edit to an existing documentation page or fork the repository to make changes to the documentation, you have to create a new branch.
Make sure that the branch name starts with
docs/. For example,
Pull Request Conventions
When you create a pull request, prefix the title with “docs:”. Make sure to keep “docs” in small letters.
In the body of the PR, explain clearly what the PR does. If the PR solves an issue, use closing keywords with the issue number. For example, “Closes #1333”.
When you add a new page to the documentation, you must add the new page in
www/docs/sidebars.js under the
tutorialSidebar. You can learn more about the syntax used here.
When the documentation page is a conceptual or overview documentation, the label in the sidebar should start with a noun.
When the documentation page is a tutorial documentation, the label in the sidebar should start with a verb. An exception of this rule are integration documentations and upgrade guides.
Notes and Additional Information
When displaying notes and additional information in a documentation page, use Admonitions. Make sure the type of admonition used matches the note’s importance to the current document.
If the note is something developers have to be careful of doing or not doing, use the
danger admonitions based on how critical it is.
If the note is defining something to the developer in case they’re not familiar with it, use the
If the note displays helpful information and tips use the
If the admonition does not match any of the mentioned criteria, always default to the
If you are adding images to a documentation page, you can host the image on Imgur for free.
NPM and Yarn Code Blocks
If you’re adding code blocks that use NPM and Yarn, you must use the npm2yarn syntax.
npm run start
The code snippet must be written using NPM, and the
npm2yarn plugin will automatically transform it to Yarn.
Don't use commands in their abbrivated terms. For example, instead of
npm i use
Make sure to always use the
run command when the command runs a script.
For example, even though you can run the
start script using NPM with
npm start, however, to make sure it’s transformed properly to a Yarn command, you must add the
run keyword before
When a command uses the global option
-g, add it at the end of the NPM command to ensure that it’s transformed to a Yarn command properly. For example:
npm install @medusajs/medusa-cli -g
Need Additional Help?
If you need any additional help while contributing, you can join our Discord server and ask Medusa’s core team as well as the community any questions.