Skip to content

Commit

Permalink
docs: small tweaks (#2215)
Browse files Browse the repository at this point in the history
  • Loading branch information
holic authored Feb 1, 2024
1 parent 648ae3c commit b52d281
Show file tree
Hide file tree
Showing 5 changed files with 30 additions and 23 deletions.
39 changes: 22 additions & 17 deletions docs/next.config.mjs
Original file line number Diff line number Diff line change
Expand Up @@ -154,62 +154,67 @@ export default withNextra({
{
source: "/tutorials/emojimon/getting-started",
destination: "/guides/emojimon/2-getting-started",
permanent: false
permanent: false,
},
{
source: "/tutorials/emojimon/players-and-movement",
destination: "/guides/emojimon/3-players-and-movement",
permanent: false
},
permanent: false,
},
{
source: "/tutorials/emojimon/map-and-terrain",
destination: "/guides/emojimon/4-map-and-terrain",
permanent: false
permanent: false,
},
{
source: "/tutorials/emojimon/a-wild-emojimon-appears",
destination: "/guides/emojimon/5-a-wild-emojimon-appears",
permanent: false
},
permanent: false,
},
{
source: "/tutorials/emojimon/make-it-multiplayer",
destination: "/guides/emojimon/6-advanced#make-it-multiplayer",
permanent: false
permanent: false,
},
{
source: "/tutorials/emojimon/deploy-to-testnet",
destination: "/cli/deploy",
permanent: false
},
permanent: false,
},
{
source: "/tutorials/minimal",
destination: "/guides/hello-world",
permanent: false
permanent: false,
},
{
source: "/tutorials/minimal/add-table",
destination: "/guides/hello-world/add-table",
permanent: false
},
permanent: false,
},
{
source: "/tutorials/minimal/add-system",
destination: "/guides/hello-world/add-system",
permanent: false
permanent: false,
},
{
source: "/tutorials/minimal/deploy",
destination: "/cli/deploy",
permanent: false
},
permanent: false,
},
{
source: "/tutorials/walkthrough/minimal-onchain",
destination: "/templates/typescript/contracts",
permanent: false
permanent: false,
},
{
source: "/reference",
destination: "/",
permanent: false
permanent: false,
},
{
source: "/cli/config",
destination: "/config",
permanent: false,
},
];
},
Expand Down
6 changes: 5 additions & 1 deletion docs/pages/_meta.js
Original file line number Diff line number Diff line change
Expand Up @@ -13,11 +13,15 @@ export default {
title: "Framework",
type: "separator",
},
config: "Config",
cli: "CLI",
"state-query": "State Query",
services: "Services",
templates: "Templates",
"---": {
type: "separator",
},
guides: "Guides",
templates: "Templates",
contribute: "Contribute",
changelog: "Changelog",
retrospectives: "Retrospectives",
Expand Down
1 change: 0 additions & 1 deletion docs/pages/cli/_meta.js
Original file line number Diff line number Diff line change
@@ -1,5 +1,4 @@
export default {
config: "Config",
tablegen: "mud tablegen",
worldgen: "mud worldgen",
test: "mud test",
Expand Down
4 changes: 2 additions & 2 deletions docs/pages/cli/config.mdx → docs/pages/config.mdx
Original file line number Diff line number Diff line change
@@ -1,12 +1,12 @@
# The World config
# MUD config

Certain CLI commands, such as [`mud tablegen`](/cli/tablegen) and [`mud worldgen`](/cli/worldgen) require the MUD configuration file.
This file needs to be named `mud.config.ts` and be in the same folder as your `foundry.toml` file.

The config is used to define:

- The tables in your project in the `tables` object of your configuration.
- The [namespace](/world/namespaces-access-control) the [`System`s](/world/systems) and tables will be deployed in.
- The [namespace](/world/namespaces-access-control) that [systems](/world/systems) and tables will be deployed in.
- The `System`s in your project.
By default, the deployer will find all Solidity matching `*System.sol` (so any file ending in `System.sol`, in any folder) and deploy them as public `System`.
If you want greater control over your systems (to change their public access or their name), you can use the `systems` object in the config.
Expand Down
3 changes: 1 addition & 2 deletions docs/pages/templates/_meta.js
Original file line number Diff line number Diff line change
@@ -1,12 +1,11 @@
export default {
introduction: "Introduction",
typescript: "TypeScript",
godot: "Godot",
pwa: "Progressive Web App (for mobile)",
swift: "Swift",
svelte: "Svelte",
unity: "Unity",
disclaimer: {
"display": "hidden"
display: "hidden",
},
};

0 comments on commit b52d281

Please sign in to comment.