Skip to content

Commit

Permalink
docs(*): fix dead links 🏎 (#2798)
Browse files Browse the repository at this point in the history
  • Loading branch information
qbzzt authored May 10, 2024
1 parent a1b1ebf commit ca36fe5
Show file tree
Hide file tree
Showing 6 changed files with 30 additions and 5 deletions.
2 changes: 1 addition & 1 deletion docs/app/page.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -242,7 +242,7 @@ export default async function HomePage() {
Newsletter
</a>
<a
href="https://discord.lattice.xyz/"
href="https://lattice.xyz/discord"
target="_blank"
rel="noopener noreferrer"
// eslint-disable-next-line max-len
Expand Down
25 changes: 25 additions & 0 deletions docs/next.config.mjs
Original file line number Diff line number Diff line change
Expand Up @@ -231,6 +231,31 @@ export default withNextra({
destination: "/templates/typescript/threejs",
permanent: false,
},
{
source: "/hello-world",
destination: "/guides/hello-world",
permanent: false,
},
{
source: "/references/store",
destination: "/store/reference/store",
permanent: false,
},
{
source: "/references/store-core",
destination: "/store/reference/store-core",
permanent: false,
},
{
source: "/store/how-mud-models-data",
destination: "/store/data-model",
permanent: false,
},
{
source: "/store/table-hooks",
destination: "/store/store-hooks",
permanent: false,
},
];
},
});
2 changes: 1 addition & 1 deletion docs/pages/store/introduction.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ You can think of tables in two ways, either [as a relational database](./how-mud

## Reading and writing data

The [`StoreCore`](./reference) library implements low-level methods for reading and writing data in a `Store` contract and the [`IStore`](./reference) interface exposes some of these methods to external callers.
The [`StoreCore`](/store/reference/store-core) library implements low-level methods for reading and writing data in a `Store` contract and the [`IStore`](/store/reference/store) interface exposes some of these methods to external callers.

Note that when exposing `IStoreWrite` methods to external callers, it is necessary to implement an access control mechanism, or use the [access control mechanisms provided by `World`](/world/namespaces-access-control).

Expand Down
2 changes: 1 addition & 1 deletion docs/pages/world/modules.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ The common use for a module is to add functionality to a `World`.
In most cases we expect that a module would:

1. Create a [namespace](./namespaces-access-control.mdx) for the new functionality.
1. Create the [tables](./.tables) and [`System`s](./systems) for the new functionality.
1. Create the [tables](./tables) and [`System`s](./systems) for the new functionality.
1. Create any access permissions required (beyond the default, which is that a `System` has access to its own namespace).
1. Either assign the ownership of the new namespace to an entity that would administer it (a user, a multisig, etc.) or burn it by assigning the namespace ownership to `address(0)`.

Expand Down
2 changes: 1 addition & 1 deletion docs/pages/world/modules/keyswithvalue.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -87,7 +87,7 @@ To get the keys you use [`getKeysWithValue`](https://github.com/latticexyz/mud/b
- The encoded lengths of the dynamic fields (the result of `<table name>.encodeLengths`)
- The encoded dynamic fields themselves (the result of `<table name>.encodeDynamic`)

For example, here is the forge script to add a task to `Tasks` in [the React template](/templates/typescript/react) and then find the key from the data.
For example, here is the forge script to add a task to `Tasks` in [the React template](https://github.com/latticexyz/mud/tree/main/templates/react) and then find the key from the data.

<CollapseCode>

Expand Down
2 changes: 1 addition & 1 deletion docs/pages/world/tables.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -68,7 +68,7 @@ We need [the `StoreSwitch` library](https://github.com/latticexyz/mud/blob/main/
import { Counter } from "../src/codegen/index.sol";
```

It is easiest if we import the definitions of the table that were generated using [`mud tablegen`](./cli/tablegen).
It is easiest if we import the definitions of the table that were generated using [`mud tablegen`](/cli/tablegen).

```solidity
address worldAddress = 0xC14fBdb7808D9e2a37c1a45b635C8C3fF64a1cc1;
Expand Down

0 comments on commit ca36fe5

Please sign in to comment.