aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorHayleigh Thompson <me@hayleigh.dev>2024-04-05 13:30:55 +0100
committerHayleigh Thompson <me@hayleigh.dev>2024-04-06 00:17:47 +0100
commitb05a630a14dfa928968cec9c4345b06ff4e6c019 (patch)
treee5b1c90e622cdaf63ce2b6c41c6668d32b5198b2
parentc7df826e1023809a6bd3521d472a3d24a80d6146 (diff)
downloadlustre-b05a630a14dfa928968cec9c4345b06ff4e6c019.tar.gz
lustre-b05a630a14dfa928968cec9c4345b06ff4e6c019.zip
:memo: Add routing guide to examples overview pages.
-rw-r--r--examples/README.md3
-rw-r--r--pages/reference/examples.md14
2 files changed, 10 insertions, 7 deletions
diff --git a/examples/README.md b/examples/README.md
index a9a7ddb..c3a6009 100644
--- a/examples/README.md
+++ b/examples/README.md
@@ -33,6 +33,9 @@ the previous ones. Feel free to jump in to any example that interests you, thoug
- [`06-custom-effects`](./06-custom-effects) builds on the previous example and
shows you how to write your own side effects for Lustre to perform.
+- [`07-routing`](./07-routing) shows you how to use [`modem`](https://hexdocs.pm/modem/)
+ to set up routing and navigating between pages in a Lustre app.
+
## Getting help
If you're having trouble with Lustre or not sure what the right way to do
diff --git a/pages/reference/examples.md b/pages/reference/examples.md
index a6a0d37..4e35ec5 100644
--- a/pages/reference/examples.md
+++ b/pages/reference/examples.md
@@ -23,20 +23,20 @@ the previous ones. Feel free to jump in to any example that interests you, thoug
demonstrates the most common way to handle `<input />` elements in Lustre.
- [`04-custom-event-handlers`](https://github.com/lustre-labs/lustre/tree/main/examples/04-custom-event-handlers)
- shows you how to write your own event handlers and decoders, instead of relying on the ones provided
- by `lustre/event`.
+ shows you how to write your own event handlers and decoders, instead of relying
+ on the ones provided by `lustre/event`.
- [`05-http-requests`](https://github.com/lustre-labs/lustre/tree/main/examples/05-http-requests)
demonstrates how side effects are handled in Lustre, using the third-party
[`lustre_http`](https://hexdocs.pm/lustre_http/) package.
- [`06-custom-effects`](https://github.com/lustre-labs/lustre/tree/main/examples/06-custom-effects)
- builds on the previous example and shows you how to write your own side effects for Lustre to
- perform.
+ builds on the previous example and shows you how to write your own side effects
+ for Lustre to perform.
-- [`07-routing`](https://github.com/lustre-labs/lustre/tree/main/examples/07-routing) shows how to use
- the routing package [`modem`](https://hexdocs.pm/modem/) to handle client-side routing in a Lustre
- application.
+- [`07-routing`](https://github.com/lustre-labs/lustre/tree/main/examples/07-routing)
+ shows how to use [`modem`](https://hexdocs.pm/modem/) to set up routing and
+ navigating between pages in a Lustre app.
## Getting help