Skip to content

Commit

Permalink
update mkdocs instructions (#617)
Browse files Browse the repository at this point in the history
homepage
  • Loading branch information
BastLeblanc authored Aug 15, 2024
1 parent 77038db commit 5a3a063
Showing 1 changed file with 13 additions and 8 deletions.
21 changes: 13 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,18 +4,22 @@
The Retail Demo Store is an eCommerce reference implementation designed to showcase how AWS services can be used to build compelling shopping experiences using modern architecture and design patterns.

> [!IMPORTANT]
> The documentation has now moved to a new location: https://docs.retaildemostore.retail.aws.dev
>
> [Main documentation](https://docs.retaildemostore.retail.aws.dev)
> The documentation is now supported by [Material for MkDocs](https://squidfunk.github.io/mkdocs-material/)
>
> You can read / browse directly on github [here](./docs/index.md)
>
> Alternatively you can clone the repo and run mkdocs locally to view the documentation:
> * Install [Mkdocs](https://squidfunk.github.io/mkdocs-material/getting-started/)
> * run `mkdocs serve` from the root of this repo
> [!NOTE]
> Jump directly to a section of the documentation:
>
> * [How to deploy an instance in your account ](https://docs.retaildemostore.retail.aws.dev/Deployment/getting-started/)
> * [Hands-on Workshops](https://docs.retaildemostore.retail.aws.dev/workshops/hands-on-workshops/)
> * [Partner Integrations](https://docs.retaildemostore.retail.aws.dev/partner-integrations/partner-integrations/)
> * [Delivering a Demo of the Retail Demo Store ](https://docs.retaildemostore.retail.aws.dev/Available%20Demos/)
> * [Troubleshooting - FAQs](https://docs.retaildemostore.retail.aws.dev/Deployment/troubleshooting/)
> * [How to deploy an instance in your account ](./docs/Deployment/getting-started.md)
> * [Hands-on Workshops](./docs/workshops/hands-on-workshops.md)
> * [Partner Integrations](./docs/partner-integrations/partner-integrations.md)
> * [Delivering a Demo of the Retail Demo Store ](./docs/Available%20Demos/index.md)
> * [Troubleshooting - FAQs](./docs/Deployment/troubleshooting.md)

**This project is intended for educational purposes only and not for production use.**
Expand All @@ -27,3 +31,4 @@ The Retail Demo Store is an eCommerce reference implementation designed to showc

![Ruff](https://github.com/aws-samples/retail-demo-store/actions/workflows/ruff.yml/badge.svg?branch=master)
![UI Build](https://github.com/aws-samples/retail-demo-store/actions/workflows/build-ui.yml/badge.svg?branch=master)

0 comments on commit 5a3a063

Please sign in to comment.