Skip to content

Commit

Permalink
mkdocs
Browse files Browse the repository at this point in the history
  • Loading branch information
BastLeblanc committed Aug 15, 2024
1 parent be4118d commit a48e6fd
Showing 1 changed file with 10 additions and 6 deletions.
16 changes: 10 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,16 +6,20 @@ The Retail Demo Store is an eCommerce reference implementation designed to showc
> [!IMPORTANT]
> The documentation is now supported by [Material for MkDocs](https://squidfunk.github.io/mkdocs-material/)
>
> You can read / browse directly on github here [here](./docs/)
> 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 ](./docs/Deployment/getting-started/)
> * [Hands-on Workshops](./docs/workshops/hands-on-workshops/)
> * [Partner Integrations](./docs/partner-integrations/partner-integrations/)
> * [Delivering a Demo of the Retail Demo Store ](./docs/Available%20Demos/)
> * [Troubleshooting - FAQs](./docs/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 Down

0 comments on commit a48e6fd

Please sign in to comment.