From 0a482e972fc79c180c148d0d5c6bde9e07bf7270 Mon Sep 17 00:00:00 2001 From: Shahed Nasser Date: Wed, 24 Jul 2024 17:16:33 +0300 Subject: [PATCH] docs: added a section to introduction on using docs (#8257) Add a section to the introduction page explaining the different sections of the V2 docs and how / when to use them. --- www/apps/book/app/page.mdx | 14 +++++++++++--- 1 file changed, 11 insertions(+), 3 deletions(-) diff --git a/www/apps/book/app/page.mdx b/www/apps/book/app/page.mdx index 8cec0b4481..0ccf17eb7b 100644 --- a/www/apps/book/app/page.mdx +++ b/www/apps/book/app/page.mdx @@ -92,8 +92,16 @@ Medusa is for ambitious businesses and developers that are limited by traditiona --- -## Who is this book for +## Who is this documentation for -This book is for TypeScript or JavaScript developers looking to master Medusa and build their commerce applications. By following this book, you’ll learn about Medusa’s concept, from basic to advanced, with easy-to-follow examples to assist you along the way. +This documentation is for TypeScript or JavaScript developers looking to master Medusa and build their commerce applications. By following this documentation, you’ll learn about Medusa’s concept, from basic to advanced, with easy-to-follow examples to assist you along the way. -By the end of this book, you’ll be an expert Medusa developer, leading teams using Medusa from the development till production. \ No newline at end of file +By the end of this documentation, you’ll be an expert Medusa developer, leading teams using Medusa from the development till production. + +### How to use the documentation + +The documentation for Medusa v2 is split into the following sections: + +1. The main documentation, which is the one you're currently viewing. It's highly recommended to follow all the chapters in this documentation before jumping into other documentation sections. +2. The [Learning Resources documentation](!resources!) provides guides and resources useful during your development, such as tool 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, and more.