diff --git a/.github/README.md b/.github/README.md index 16d9426a..356a7e1f 100644 --- a/.github/README.md +++ b/.github/README.md @@ -42,7 +42,7 @@ dotnet add package Umbraco.Community.Merchello@1.0.0-beta.4 Then you need to add merchello to the Umbraco builder -``` +```csharp builder.CreateUmbracoBuilder() .AddBackOffice() .AddWebsite() @@ -53,29 +53,40 @@ builder.CreateUmbracoBuilder() It's important you set some starting settings in your appSettings to your preference before starting up the project, these are the defaults (If you don't want seed data set that to false) -``` +```json +{ "Merchello": { "InstallSeedData": true, "StoreCurrencyCode": "USD", "DefaultShippingCountry": "US" } +} ``` By all means change the StoreCurrencyCode (ISO 4217 code) and DefaultShippingCountry (ISO 3166-1 alpha-2 country code) to whatever you want. Once installed, you need to enable the Merchello section in the Admin users group (Like you would do any new section). -#### Seed Data +### Seed Data If you left InstallSeedData = true and now click on the main Merchello root branch in the tree, you should see an Install Seed data panel. If you click install, that will install a lot of test data, it can take some time, the panel will disappear when it's done. -#### usync +### uSync + +Don't forget to watch the video about using uSync to get the starter content and doc types setup and running. + +## Documentation -Don't forget to watch the video about using usync to get the starter content and doc types setup and running. +Full developer documentation is available at **[YodasMyDad.github.io/Merchello](https://YodasMyDad.github.io/Merchello/)**. -## Docs +The docs cover everything from installation and building your first store through to creating custom payment, shipping, tax, and fulfilment providers. Highlights include: -Sorry, not quite got there yet, but will try and get something up soon. With AI, you can now get it to summarise things if need be in the meantime. +- [Installation Guide](https://YodasMyDad.github.io/Merchello/getting-started/installation/) — get up and running in minutes +- [Starter Site Walkthrough](https://YodasMyDad.github.io/Merchello/getting-started/starter-site-walkthrough/) — guided tour of the example store +- [Configuration Reference](https://YodasMyDad.github.io/Merchello/getting-started/configuration-reference/) — every `appsettings.json` option explained +- [Checkout Flow](https://YodasMyDad.github.io/Merchello/checkout/checkout-flow/) — the complete checkout pipeline +- [Extending Merchello](https://YodasMyDad.github.io/Merchello/extending/extension-manager/) — build custom providers and plugins +- [API Reference](https://YodasMyDad.github.io/Merchello/api/storefront-api/) — storefront, checkout, admin, and webhook APIs ## What's Included diff --git a/docs/documentation/getting-started/starter-site-walkthrough.md b/docs/documentation/getting-started/starter-site-walkthrough.md index ec619d12..2174d253 100644 --- a/docs/documentation/getting-started/starter-site-walkthrough.md +++ b/docs/documentation/getting-started/starter-site-walkthrough.md @@ -2,6 +2,12 @@ The `Merchello.Site` project is a working example store that shows you how to build a storefront with Merchello. Whether you used the .NET template or cloned the repo, this guide walks you through every piece so you understand how it all fits together. +## Video Walkthrough + +Watch this quick video to see the starter site in action, including how to install the content using uSync: + +[![Starter Site YouTube Video](https://img.youtube.com/vi/jRSXaJpZekE/0.jpg)](https://www.youtube.com/watch?v=jRSXaJpZekE) + ## Overview The starter site is deliberately simple -- it is a bare-bones example showing the key integration points. It uses Umbraco's standard MVC patterns (route hijacking via `SurfaceController`) and demonstrates: