diff --git a/docs/.vitepress/config.ts b/docs/.vitepress/config.ts index c3a6f60..581ebb6 100644 --- a/docs/.vitepress/config.ts +++ b/docs/.vitepress/config.ts @@ -61,6 +61,7 @@ const sidebars = (): DefaultTheme.SidebarItem[] => [ items: [ { text: "Overview", link: "/examples/" }, { text: "Server: Tractor Shop", link: "/examples/server/tractor-shop" }, + { text: "Server: Community Template", link: "/examples/server/template" }, { text: "SPA: Tractor Shop", link: "/examples/spa/tractor-shop" }, ], }, @@ -98,12 +99,11 @@ export default defineConfig({ }, footer: { message: "Released under the MIT License.", - copyright: "Copyright © 2020 - 2024 smapiot & contributors", + copyright: "Copyright © 2020 - 2024 smapiot & contributors. Imprint", }, nav: [ { text: "Docs", link: "/getting-started/" }, { text: "Examples", link: "/examples/" }, - { text: "Imprint", link: "/imprint" }, ], sidebar: { "/": sidebars(), diff --git a/docs/examples/index.md b/docs/examples/index.md index 0751630..d59a4a4 100644 --- a/docs/examples/index.md +++ b/docs/examples/index.md @@ -5,6 +5,7 @@ Here are some example code bases that will help you understand what `Piral.Blazo ## Server - [Tractor Shop](./server/tractor-shop.md) +- [Template](./server/template.md) ## SPA diff --git a/docs/examples/server/template.md b/docs/examples/server/template.md new file mode 100644 index 0000000..697a54e --- /dev/null +++ b/docs/examples/server/template.md @@ -0,0 +1,12 @@ +# Server Example: Community Template + +This is a template that simplifies your start with Piral.Blazor.Server. + +The template includes: + +- App Shell project +- Two micro frontend projects (weather and counter) + +The code for this example is available at [github.com/wdevon99/Blazor-Microfrontends](https://github.com/wdevon99/Blazor-Microfrontends). + +More information regarding this template can also be found in the [article by Devon Wijesinghe](https://engineering.99x.io/building-micro-frontends-using-blazor-and-piral-framework-c38c5426ccee). diff --git a/docs/examples/server/tractor-shop.md b/docs/examples/server/tractor-shop.md index 9266ba4..be0824c 100644 --- a/docs/examples/server/tractor-shop.md +++ b/docs/examples/server/tractor-shop.md @@ -1,3 +1,13 @@ -# Server: Tractor Shop +# Server Example: Tractor Shop -More infos soon. +This example reconstructs the famous [Tractor Store v1](https://micro-frontends.org) example from Michael Geers. It separates each micro frontend in its own project - making them truly independent and deployable as individual pieces. + +Besides the implementation of the Tractor Store the example also shows how debugging of individual pieces can work in a joint setup. For this a few extras have been included. + +The example includes: + +- App Shell project +- Three micro frontend projects (red, blue, green) +- One empty micro frontend project showing how joint debugging / development works + +The code for this example is available at [github.com/FlorianRappl/Piral.Blazor.Server.Samples.Tractor](https://github.com/FlorianRappl/Piral.Blazor.Server.Samples.Tractor). diff --git a/docs/examples/spa/tractor-shop.md b/docs/examples/spa/tractor-shop.md index a91f2d0..41f475a 100644 --- a/docs/examples/spa/tractor-shop.md +++ b/docs/examples/spa/tractor-shop.md @@ -1,3 +1,3 @@ -# SPA: Tractor Shop +# SPA Example: Tractor Shop More infos soon. diff --git a/docs/guides/faq.md b/docs/guides/faq.md index 05839a0..6138f58 100644 --- a/docs/guides/faq.md +++ b/docs/guides/faq.md @@ -1,5 +1,11 @@ # Frequently Asked Questions -1. I cannot use breakpoints when I debug a Piral.Blazor pilet in VS. What could be wrong? +### I cannot use breakpoints when I debug a Piral.Blazor pilet in VS. What could be wrong? Make sure you actually emit a PDB and have `Debug` selected as configuration. Also, don't change the configuration to have `Full` or similar in the project file. You'll need a portable PDB (modern format), not a full PDB (legacy format for Windows). + +### I think I need more help. Is there support available? + +Yes - just get in touch with us and we can figure out a way to support your development efforts (once, more often, or even continuously). + +One way to reach us is to join the [Discord server](https://discord.gg/kKJ2FZmK8t) and explain your problem there. diff --git a/docs/guides/index.md b/docs/guides/index.md index 50a8673..546e14d 100644 --- a/docs/guides/index.md +++ b/docs/guides/index.md @@ -1 +1,5 @@ # Guides + +- [Helpers](./helpers.md) +- [FAQs](./faq.md) +- [Roadmap](./roadmap.md)