latticexyz / mud

MUD is a framework for building autonomous worlds
https://mud.dev
MIT License
736 stars 185 forks source link

Redo the `mud.config.ts` page #2994

Closed qbzzt closed 2 months ago

qbzzt commented 3 months ago

Ludens: so as we need to do a bunch of doc work on namespaces here https://mud.dev/config; it would be good to bundle that with a lot of different examples of MUD configs and breaking them down cc @Ori Pomerantz i was trying to explain a MUD config to someone and that page in the doc is one of the most lacking

Frolic: agreed! I think this page could become more of a guide on how to get started with the config (single vs multiple namespaces, how to use each top-level key, etc.)

then a sub page that ideally is generated from the TS doc that explains each config option so we don't have to keep em in sync the config on this page is wrong anyway! overdue for an update

holic commented 2 months ago

gonna consider this done for now