Skip to content

Commit

Permalink
[Doc improvement] Fix dead links, adjust link names (#3241)
Browse files Browse the repository at this point in the history
* Fix broken doc link for DOM patching

* Match links in Welcome section to the links in the sidebar

* Fix ex_doc warnings

* Sync link name of uploads-external.md

---------

Co-authored-by: c4710n <c4710n@users.noreply.github.com>
  • Loading branch information
c4710n and c4710n committed May 15, 2024
1 parent fd4e4d9 commit 6ce0613
Show file tree
Hide file tree
Showing 6 changed files with 15 additions and 15 deletions.
10 changes: 5 additions & 5 deletions guides/cheatsheets/html-attrs.cheatmd
Original file line number Diff line number Diff line change
Expand Up @@ -100,11 +100,11 @@ Attribute values can be:

## DOM Element Lifecycle

| Attribute | Value |
|--------------------------------------------|----------------------------------------------------------------------------------------|
| [`phx-mounted`](../client/dom-patching.md) | [JS commands](../client/bindings.md#js-commands) executed after the element is mounted |
| [`phx-remove`](../client/dom-patching.md) | [JS commands](../client/bindings.md#js-commands) executed during the element removal |
| [`phx-update`](../client/dom-patching.md) | `"replace"` (default), `"stream"` or `"ignore"`, configures DOM patching behavior |
| Attribute | Value |
|-----------------------------------------------------|----------------------------------------------------------------------------------------|
| [`phx-mounted`](../client/bindings.md#dom-patching) | [JS commands](../client/bindings.md#js-commands) executed after the element is mounted |
| [`phx-remove`](../client/bindings.md#dom-patching) | [JS commands](../client/bindings.md#js-commands) executed during the element removal |
| [`phx-update`](../client/bindings.md#dom-patching) | `"replace"` (default), `"stream"` or `"ignore"`, configures DOM patching behavior |

#### lib/hello_web/live/hello_live.html.heex

Expand Down
2 changes: 1 addition & 1 deletion guides/client/js-interop.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ except for the following LiveView specific options:
section below for details.
* `uploaders` – a reference to a user-defined uploaders namespace, containing
client callbacks for client-side direct-to-cloud uploads. See the
[External Uploads guide](uploads-external.md) for details.
[External uploads guide](uploads-external.md) for details.

## Debugging Client Events

Expand Down
2 changes: 1 addition & 1 deletion guides/client/uploads-external.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# External Uploads
# External uploads

> This guide continues from the configuration started in the
> server [Uploads guide](uploads.html).
Expand Down
12 changes: 6 additions & 6 deletions guides/introduction/welcome.md
Original file line number Diff line number Diff line change
Expand Up @@ -286,20 +286,20 @@ split on server-side and client-side:
These guides focus on server-side functionality:

* [Assigns and HEEx templates](assigns-eex.md)
* [Deployments](deployments.md)
* [Error and exception handling](error-handling.md)
* [Live Layouts](live-layouts.md)
* [Live Navigation](live-navigation.md)
* [Security considerations of the LiveView model](security-model.md)
* [Live layouts](live-layouts.md)
* [Live navigation](live-navigation.md)
* [Security considerations](security-model.md)
* [Telemetry](telemetry.md)
* [Uploads](uploads.md)
* [Using Gettext for internationalization](using-gettext.md)
* [Gettext for internationalization](using-gettext.md)

### Client-side

These guides focus on LiveView bindings and client-side integration:

* [Bindings](bindings.md)
* [Form bindings](form-bindings.md)
* [DOM patching and temporary assigns](dom-patching.md)
* [JavaScript interoperability](js-interop.md)
* [Uploads (External)](uploads-external.md)
* [External uploads](uploads-external.md)
2 changes: 1 addition & 1 deletion guides/server/uploads.md
Original file line number Diff line number Diff line change
Expand Up @@ -212,7 +212,7 @@ ultimately fail.
For these reasons, it is best if uploads are stored elsewhere, such as the
database (depending on the size and contents) or a separate storage service.
For more information on implementing client-side, direct-to-cloud uploads,
see the [External Uploads guide](uploads-external.md).
see the [External uploads guide](uploads-external.md) for details.

## Appendix A: UploadLive

Expand Down
2 changes: 1 addition & 1 deletion mix.exs
Original file line number Diff line number Diff line change
Expand Up @@ -68,7 +68,7 @@ defmodule Phoenix.LiveView.MixProject do
extras: extras(),
groups_for_extras: groups_for_extras(),
groups_for_modules: groups_for_modules(),
groups_for_functions: [
groups_for_docs: [
Components: &(&1[:type] == :component),
Macros: &(&1[:type] == :macro)
],
Expand Down

0 comments on commit 6ce0613

Please sign in to comment.