aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorHayleigh Thompson <me@hayleigh.dev>2024-04-16 22:37:59 +0100
committerHayleigh Thompson <me@hayleigh.dev>2024-04-16 22:37:59 +0100
commit5e1031a26fbb1baa1f96cfbba15cf55756ba3927 (patch)
tree3413b468adbe56049a9e078b661001f88c25812b
parentdccf163453c47d0cb283070babb7a453b134040e (diff)
downloadlustre-5e1031a26fbb1baa1f96cfbba15cf55756ba3927.tar.gz
lustre-5e1031a26fbb1baa1f96cfbba15cf55756ba3927.zip
:memo: Fix broken docs links.
-rw-r--r--pages/guide/01-quickstart.md2
-rw-r--r--src/lustre.gleam12
-rw-r--r--src/lustre/element.gleam6
3 files changed, 10 insertions, 10 deletions
diff --git a/pages/guide/01-quickstart.md b/pages/guide/01-quickstart.md
index c679c05..e3ced4e 100644
--- a/pages/guide/01-quickstart.md
+++ b/pages/guide/01-quickstart.md
@@ -403,7 +403,7 @@ how you like to learn:
section of the guide to learn about how to run Lustre applications on the backend.
- Of course, if you want to dive in and start making things straight away, the
- [API documentation](/lustre) is always handy to keep open.
+ [API documentation](https://hexdocs.pm/lustre/lustre.html) is always handy to keep open.
## Getting help
diff --git a/src/lustre.gleam b/src/lustre.gleam
index f5b79f9..99d97b3 100644
--- a/src/lustre.gleam
+++ b/src/lustre.gleam
@@ -25,7 +25,7 @@
////
//// The server component runtime can run anywhere Gleam does, but the
//// client-side runtime must be run in a browser. To use it either render the
-//// [provided script element](./lustre/server#script) or use the script files
+//// [provided script element](./lustre/server_component.html#script) or use the script files
//// from Lustre's `priv/` directory directly.
////
//// No matter where a Lustre application runs, it will always follow the same
@@ -78,7 +78,7 @@
////
//// The `Effect` type here encompasses things like HTTP requests and other kinds
//// of communication with the "outside world". You can read more about effects
-//// and their purpose in the [`effect`](./effect) module.
+//// and their purpose in the [`effect`](./effect.html) module.
////
//// For many kinds of app, you can take these three building blocks and put
//// together a Lustre application capable of running *anywhere*. Beacuse of that,
@@ -90,7 +90,7 @@
//// different kinds of applications. If you're just getting started with Lustre
//// or frontend development, we recommend reading through them in order:
////
-//// - [`01-quickstart`](/guide/01-quickstart)
+//// - [`01-quickstart`](/guide/01-quickstart.html)
////
//// This list of guides is likely to grow over time, so be sure to check back
//// every now and then to see what's new!
@@ -196,7 +196,7 @@ import lustre/internals/runtime
///
/// If you're only interested in using Lustre as a HTML templating engine, you
/// don't need an `App` at all! You can render an element directly using the
-/// [`element.to_string`](./lustre/element#to_string) function.
+/// [`element.to_string`](./lustre/element.html#to_string) function.
///
pub opaque type App(flags, model, msg) {
App(
@@ -322,7 +322,7 @@ pub fn simple(
/// Lustre applications will use this constructor.
///
/// To learn more about effects and their purpose, take a look at the
-/// [`effect`](./lustre/effect) module or the
+/// [`effect`](./lustre/effect.html) module or the
/// [HTTP requests example](https://github.com/lustre-labs/lustre/tree/main/examples/05-http-requests).
///
pub fn application(
@@ -347,7 +347,7 @@ pub fn application(
/// in frameworks like React. They should be used for more complex UI widgets
/// like a combobox with complex keyboard interactions rather than simple things
/// like buttons or text inputs. Where possible try to think about how to build
-/// your UI with simple view functions (functions that return [Elements](./lustre/element#Element))
+/// your UI with simple view functions (functions that return [Elements](./lustre/element.html#Element))
/// and only reach for components when you really need to encapsulate that update
/// loop.
///
diff --git a/src/lustre/element.gleam b/src/lustre/element.gleam
index 8487db3..392a777 100644
--- a/src/lustre/element.gleam
+++ b/src/lustre/element.gleam
@@ -48,8 +48,8 @@ import lustre/internals/vdom.{Element, Map, Text}
/// For most applications, you'll only need to use the simpler functions; usually
/// the [`text`](#text) and [`none`](#none) functions are enough. This is because
/// Lustre already provides a module with all the standard HTML and SVG elements
-/// ready to use in [`lustre/element/html`](./element/html) and
-/// [`lustre/element/svg`](./element/svg).
+/// ready to use in [`lustre/element/html`](./element/html.html) and
+/// [`lustre/element/svg`](./element/svg.html).
///
pub type Element(msg) =
vdom.Element(msg)
@@ -57,7 +57,7 @@ pub type Element(msg) =
// CONSTRUCTORS ----------------------------------------------------------------
/// A general function for constructing any kind of element. In most cases you
-/// will want to use the [`lustre/element/html`](./element/html) instead but this
+/// will want to use the [`lustre/element/html`](./element/html.html) instead but this
/// function is particularly handing when constructing custom elements, either
/// from your own Lustre components or from external JavaScript libraries.
///