Skip to content

Commit

Permalink
Improved docs
Browse files Browse the repository at this point in the history
  • Loading branch information
FlorianRappl committed Sep 19, 2024
1 parent e47436c commit dca29bb
Show file tree
Hide file tree
Showing 7 changed files with 39 additions and 6 deletions.
4 changes: 2 additions & 2 deletions docs/.vitepress/config.ts
Original file line number Diff line number Diff line change
Expand Up @@ -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" },
],
},
Expand Down Expand Up @@ -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. <a href='/imprint'>Imprint</a>",
},
nav: [
{ text: "Docs", link: "/getting-started/" },
{ text: "Examples", link: "/examples/" },
{ text: "Imprint", link: "/imprint" },
],
sidebar: {
"/": sidebars(),
Expand Down
1 change: 1 addition & 0 deletions docs/examples/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down
12 changes: 12 additions & 0 deletions docs/examples/server/template.md
Original file line number Diff line number Diff line change
@@ -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).
14 changes: 12 additions & 2 deletions docs/examples/server/tractor-shop.md
Original file line number Diff line number Diff line change
@@ -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).
2 changes: 1 addition & 1 deletion docs/examples/spa/tractor-shop.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,3 @@
# SPA: Tractor Shop
# SPA Example: Tractor Shop

More infos soon.
8 changes: 7 additions & 1 deletion docs/guides/faq.md
Original file line number Diff line number Diff line change
@@ -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 `<DebugType>Full</DebugType>` 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.
4 changes: 4 additions & 0 deletions docs/guides/index.md
Original file line number Diff line number Diff line change
@@ -1 +1,5 @@
# Guides

- [Helpers](./helpers.md)
- [FAQs](./faq.md)
- [Roadmap](./roadmap.md)

0 comments on commit dca29bb

Please sign in to comment.